| 1 |
<?php |
| 2 |
|
| 3 |
/** |
| 4 |
* |
| 5 |
* Class for the creating "special" Matrices |
| 6 |
* |
| 7 |
* @copyright Copyright (c) 2018 Mark Baker (https://github.com/MarkBaker/PHPMatrix) |
| 8 |
* @license https://opensource.org/licenses/MIT MIT |
| 9 |
*/ |
| 10 |
namespace Matrix; |
| 11 |
|
| 12 |
/** |
| 13 |
* Matrix Builder class. |
| 14 |
* |
| 15 |
* @package Matrix |
| 16 |
*/ |
| 17 |
class Builder |
| 18 |
{ |
| 19 |
/** |
| 20 |
* Create a new matrix of specified dimensions, and filled with a specified value |
| 21 |
* If the column argument isn't provided, then a square matrix will be created |
| 22 |
* |
| 23 |
* @param $value |
| 24 |
* @param $rows |
| 25 |
* @param null $columns |
| 26 |
* @return Matrix |
| 27 |
* @throws Exception |
| 28 |
*/ |
| 29 |
public static function createFilledMatrix($value, $rows, $columns = null) |
| 30 |
{ |
| 31 |
if ($columns === null) { |
| 32 |
$columns = $rows; |
| 33 |
} |
| 34 |
|
| 35 |
$rows = Matrix::validateRow($rows); |
| 36 |
$columns = Matrix::validateColumn($columns); |
| 37 |
|
| 38 |
return new Matrix( |
| 39 |
array_fill( |
| 40 |
0, |
| 41 |
$rows, |
| 42 |
array_fill( |
| 43 |
0, |
| 44 |
$columns, |
| 45 |
$value |
| 46 |
) |
| 47 |
) |
| 48 |
); |
| 49 |
} |
| 50 |
|
| 51 |
/** |
| 52 |
* Create a new identity matrix of specified dimensions |
| 53 |
* This will always be a square matrix, with the number of rows and columns matching the provided dimension |
| 54 |
* |
| 55 |
* @param int $dimensions |
| 56 |
* @return Matrix |
| 57 |
* @throws Exception |
| 58 |
*/ |
| 59 |
public static function createIdentityMatrix($dimensions) |
| 60 |
{ |
| 61 |
$grid = static::createFilledMatrix(null, $dimensions)->toArray(); |
| 62 |
|
| 63 |
for ($x = 0; $x < $dimensions; ++$x) { |
| 64 |
$grid[$x][$x] = 1; |
| 65 |
} |
| 66 |
|
| 67 |
return new Matrix($grid); |
| 68 |
} |
| 69 |
} |
| 70 |
|
