summaryrefslogblamecommitdiffstats
path: root/vendor/markbaker/matrix/classes/src/Functions/antidiagonal.php
blob: 890491299b9e9fed9748999e18c3c9d0fbdc5e1e (plain) (tree)






























                                                                                      
<?php

/**
 *
 * Function code for the matrix antidiagonal() function
 *
 * @copyright  Copyright (c) 2018 Mark Baker (https://github.com/MarkBaker/PHPMatrix)
 * @license    https://opensource.org/licenses/MIT    MIT
 */
namespace Matrix;

/**
 * Returns the antidiagonal of a matrix or an array.
 *
 * @param     Matrix|array     $matrix    Matrix or an array to treat as a matrix.
 * @return    Matrix           The new matrix
 * @throws    Exception        If argument isn't a valid matrix or array.
 */
if (!function_exists(__NAMESPACE__ . '\\antidiagonal')) {
    function antidiagonal($matrix): Matrix
    {
        if (is_array($matrix)) {
            $matrix = new Matrix($matrix);
        }
        if (!$matrix instanceof Matrix) {
            throw new Exception('Must be Matrix or array');
        }

        return Functions::antidiagonal($matrix);
    }
}