chippyash/logic-matrix

PHP Logical Matrix package

chippyash/logical-matrix

Quality Assurance

, _(*1)

See the Test Contract, _(*2)

Please note that developer support for PHP5.4 & 5.5 was withdrawn at version 3.0.0 of this library. If you need support for PHP 5.4 or 5.5, please use a version >=2,<3, _(*3)

What?

This library aims to provide logic matrix functionality and builds on the chippyash/Matrix matrix data structure library:, _(*4)

• Everything has a test case
• It's PHP 5.4+

When

The current library covers basic logical matrix manipulation., _(*5)

If you want more, either suggest it, or better still, fork it and provide a pull request., _(*6)

Check out chippyash/Matrix for Matrix data type support., _(*7)

Check out chippyash/Math-Matrix for mathematical matrix operations, _(*8)

Check out ZF4 Packages for more packages, _(*9)

Operations supported

• AndMatrix - return the result of two matrices ANDed
• AndOperand - return matrix ANDed with a boolean operand
• Not - return !matrix
• OrMatrix - return the result of two matrices ORed
• OrOperand - return matrix ORed with a boolean operand
• XorMatrix - return the result of two matrices XORed
• XorOperand - return matrix XORed with a boolean operand

The library is released under the GNU GPL V3 or later license, _(*10)

How

Please see the chippyash/Matrix for underlying functionality. Anything you can do with a Matrix, you can do with a LogicalMatrix., _(*11)

Coding Basics

A LogicalMatrix is a matrix for which all entries are a boolean value; true or false, _(*12)

A shortcut for a single item matrix is to supply a single array, _(*13)

    use chippyash\Logic\Matrix\LogicalMatrix;

    $mA = new LogicalMatrix([]);  //empty matrix
    $mA = new LogicalMatrix([[]]);  //empty matrix
    $mA = new LogicalMatrix([true]);  //single item matrix
    $mA = new LogicalMatrix([2, false]);  //1x2 matrix
    $mA = new LogicalMatrix([2, false],[true, 'foo']);  //2x2 matrix

N.B. A matrix construction values are converted to their boolean equivalent, so '' = false, 'foo' = true, 1 = true, 0 = false etc, according to normal PHP casting rules for boolean., _(*14)

As with any TDD application, the tests tell you everything you need to know about the SUT. Read them! However for the short of temper amongst us, the salient points are:, _(*15)

A Logical Matrix type is supplied, _(*16)

• LogicalMatrix(array $source, bool $normalizeDefault = false)

Logical Matrices have additional attributes over and above a Matrix

• Attributes always return a boolean.
• You can use the is() method of a Matrix to test for an attribute
• Attributes implement the chippyash\Matrix\Interfaces\AttributeInterface

    //assuming $mA is a LogicalMatrix - this will return true
    if ($mA->is('Logical')) {}
    //is the same as, which can also be used on ordinary matrices
    $attr = new Logic\Matrix\Attribute\IsLogical();
    if ($attr($mA) {}

Logical Matrices have operations

• Operations always returns a Logical Matrix
• The original matrix is untouched
• You can use the magic __invoke functionality
• Operations implement the chippyash\Logical\Matrix\Interfaces\OperationInterface

    $mC = $mA("AndMatrix", $mB);
    //same as :
    $op = new Logic\Matrix\Operation\AndMatrix;
    $mC = $op($mA, $mB);

The following operations are supplied:, _(*17)

• AndMatrix - AND two matrices
• AndOperand - AND matrix with boolean
• Not - NOT a matrix
• OrMatrix - OR two matrices
• OrOperand - OR matrix with boolean
• XorMatrix - XOR two matrices
• XorOperand - XOR matrix with boolean

The magic invoke methods allow you to write in a functional way

        $fAnd = new AndMatrix();
        $fOr = new OrOperand();
        //($mA && $mB) || true
        return $fOr($fAnd($mA, $mB), true);

Changing the library

1. fork it
2. write the test
3. amend it
4. do a pull request

Found a bug you can't figure out?, _(*18)

1. fork it
2. write the test
3. do a pull request

NB. Make sure you rebase to HEAD before your pull request, _(*19)

Where?

The library is hosted at Github. It is available at Packagist.org, _(*20)

Installation

Install Composer, _(*21)

For production

add, _(*22)

    "chippyash/logical-matrix": "~2.0"

to your composer.json "requires" section, _(*23)

For development

Clone this repo, and then run Composer in local repo root to pull in dependencies, _(*24)

    git clone git@github.com:chippyash/Logical-matrix.git LogicMatrix
    cd LogicMatrix
    composer update

To run the tests:, _(*25)

    cd LogicMatrix
    vendor/bin/phpunit -c test/phpunit.xml test/

License

This software library is released under the BSD 3 Clause license, _(*26)

This software library is Copyright (c) 2014-2018, Ashley Kitson, UK, _(*27)

History

V0... pre releases, _(*28)

V1.0.0 Original release, _(*29)

V1.0.5 Update for underlying library dependency, _(*30)

V1.0.6 Update phpunit version, _(*31)

V2.0.0 BC Break: change namespace from chippyash to Chippyash, _(*32)

V2.0.1 Add link to packages, _(*33)

V2.0.2 Verify PHP7 compatibility, _(*34)

V2.0.3 Update build script, _(*35)

V3.0.0 BC Break. Withdraw support for old PHP versions, _(*36)

V3.1.0 Change of license from GPL V3 to BSD 3 Clause, _(*37)