summaryrefslogtreecommitdiffstats
path: root/src/math/matrix.php
blob: dae2f64badf86351dbc06fb50931459237a9f227 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<?php
/**
 * File containing the abstract ezcGraphMatrix class
 *
 * @package Graph
 * @version //autogentag//
 * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
 * @license http://ez.no/licenses/new_bsd New BSD License
 */
/**
 * Provides a genereic matrix class with basic math operations
 *
 * @package Graph
 */
class ezcGraphMatrix
{

    protected $columns;

    protected $rows;

    protected $matrix;

    /**
     * Constructor
     *
     * Creates a matrix with given dimensions. Optionally accepts an array to 
     * define the initial matrix values. If no array is given an identity 
     * matrix is created.
     * 
     * @param int $columns Number of columns
     * @param int $rows Number of rows
     * @param array $values Array with values
     * @return void
     */
    public function __construct( $columns = 3, $rows = 3, array $values = null )
    {
        $this->columns = max( 2, (int) $columns );
        $this->rows = max( 2, (int) $rows );

        if ( $values !== null )
        {
            $this->fromArray( $values );
        }
        else
        {
            $this->init();
        }
    }

    /**
     * Create matrix from array
     *
     * Use the array values to set matrix values
     * 
     * @param array $values Array with values
     * @return ezcGraphMatrix Modified matrix
     */
    public function fromArray( array $values )
    {
        for ( $i = 0; $i < $this->columns; ++$i )
        {
            for ( $j = 0; $j < $this->rows; ++$j )
            {
                $this->matrix[$i][$j] =
                    ( isset( $values[$i][$j] )
                    ? (float) $values[$i][$j]
                    : 0 );
            }
        }

        return $this;
    }

    /**
     * Init matrix
     *
     * Sets matrix to identity matrix
     * 
     * @return ezcGraphMatrix Modified matrix
     */
    public function init()
    {
        for ( $i = 0; $i < $this->columns; ++$i )
        {
            for ( $j = 0; $j < $this->rows; ++$j )
            {
                $this->matrix[$i][$j] = ( $i === $j ? 1 : 0 );
            }
        }

        return $this;
    }

    /**
     * Returns number of columns 
     * 
     * @return int Number of columns
     */
    public function columns()
    {
        return $this->columns;
    }

    /**
     * Returns number of rows
     * 
     * @return int Number of rows
     */
    public function rows()
    {
        return $this->rows;
    }

    /**
     * Get a single matrix value
     *
     * Returns the value of the matrix at the given position
     * 
     * @param int $i Row
     * @param int $j Column
     * @return float Matrix value
     */
    public function get( $i, $j )
    {
        if ( !isset( $this->matrix[$i][$j] ) )
        {
            throw new ezcGraphMatrixOutOfBoundingsException( $this->columns, $this->rows, $i, $j );
        }

        return $this->matrix[$i][$j];
    }

    /**
     * Set a single matrix value
     *
     * Sets the value of the matrix at the given position
     * 
     * @param int $i Row
     * @param int $j Column
     * @param float $value Value
     * @return ezcGraphMatrix Updated matrix
     */
    public function set( $i, $j, $value )
    {
        if ( !isset( $this->matrix[$i][$j] ) )
        {
            throw new ezcGraphMatrixOutOfBoundingsException( $this->columns, $this->rows, $i, $j );
        }

        $this->matrix[$i][$j] = $value;

        return $this;
    }

    /**
     * Adds one matrix to the current one
     *
     * Calculate the sum of two matrices and returns the resulting matrix.
     * 
     * @param ezcGraphMatrix $matrix Matrix to sum with
     * @return ezcGraphMatrix Result matrix
     */
    public function add( ezcGraphMatrix $matrix )
    {
        if ( ( $this->columns !== $matrix->columns() ) ||
             ( $this->rows !== $matrix->rows() ) )
        {
            throw new ezcGraphMatrixInvalidDimensionsException( $this->columns, $this->rows, $matrix->columns(), $matrix->rows() );
        }

        for ( $i = 0; $i < $this->columns; ++$i )
        {
            for ( $j = 0; $j < $this->rows; ++$j )
            {
                $this->matrix[$i][$j] += $matrix->get( $i, $j );
            }
        }

        return $this;
    }

    /**
     * Subtracts matrix from current one
     *
     * Calculate the diffenrence of two matices and returns the result matrix.
     * 
     * @param ezcGraphMatrix $matrix subtrahend
     * @return ezcGraphMatrix Result matrix
     */
    public function diff( ezcGraphMatrix $matrix )
    {
        if ( ( $this->columns !== $matrix->columns() ) ||
             ( $this->rows !== $matrix->rows() ) )
        {
            throw new ezcGraphMatrixInvalidDimensionsException( $this->columns, $this->rows, $matrix->columns(), $matrix->rows() );
        }

        for ( $i = 0; $i < $this->columns; ++$i )
        {
            for ( $j = 0; $j < $this->rows; ++$j )
            {
                $this->matrix[$i][$j] -= $matrix->get( $i, $j );
            }
        }

        return $this;
    }

    /**
     * Scalar multiplication
     *
     * Multiplies matrix with the given scalar and returns the result matrix
     * 
     * @param float $scalar Scalar
     * @return ezcGraphMatrix Result matrix
     */
    public function scalar( $scalar )
    {
        $scalar = (float) $scalar;

        for ( $i = 0; $i < $this->columns; ++$i )
        {
            for ( $j = 0; $j < $this->rows; ++$j )
            {
                $this->matrix[$i][$j] *= $scalar;
            }
        }
    }

	/**
     * Multiplies two matrices
     *
     * Multiply current matrix with another matrix and returns the result 
     * matrix.
     *
     * @param ezcGraphMatrix $matrix Second factor
     * @returns ezcGraphMatrix Result matrix
     */
	public function multiply( ezcGraphMatrix $matrix ) 
    {
        $mColumns = $matrix->columns();
        if ( $this->columns !== ( $mRows = $matrix->rows() ) ) 
        {
            throw new ezcGraphMatrixInvalidDimensionsException( $this->columns, $this->rows, $mColumns, $mRows );
        }

        $result = new ezcGraphMatrix( $mRows, $mRows );

		for ( $i = 0; $i < $this->columns; ++$i ) 
        {
			for ( $j = 0; $j < $mRows; ++$j ) 
            {
				$sum = 0;
				for ( $k = 0; $k < $mColumns; ++$k ) {
					$sum += $this->matrix[$i][$k] * $matrix->get( $k, $j );
				}

				$result->set( $i, $j, $sum );
			}
		}

        return $result;
    }
}
?>
OpenPOWER on IntegriCloud