summaryrefslogblamecommitdiffstats
path: root/vendor/markbaker/matrix/classes/src/Functions/transpose.php
blob: 8413634b7158e3d5dd52633854a5705e29a24125 (plain) (tree)































                                                                                      
<?php

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

namespace Matrix;

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

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