File Source for Matrix.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package data_structures
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\r\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\r\n";
exit();
}
/**
*
*/
require_once( CLASSPATH."core/Arrays.class.php" );
/**
* @package data_structures
*
* @version 0.1.0
* @since 0.9.1.8
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2004 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class Matrix
{
/**
* The number of rows in this matrix.
*
* @access public
* @var integer $int_rows
*/
var $int_rows = 0;
/**
* The number of cols in this matrix.
*
* @access public
* @var integer $int_cols
*/
var $int_cols = 0;
/**
* The stored matrix data.
*
* @access public
* @var array $dbl_m_arr
*/
var $dbl_m_arr = array();
/**
* Constructor
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $rows
* @param integer $cols
* @return void
*/
function Matrix( $rows = 0, $cols = 0 )
{
$this->int_rows = $rows;
$this->int_cols = $cols;
}
/**
* Uses a arra to generate this matrix.
*
* @version 1.0
* @since 0.1.0
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param array $data_arr
* @return boolean
*/
function inputArray( &$data_arr )
{
if ( !is_array( $data_arr[0] ) )
return false;
$this->int_rows = count( $data_arr );
$this->int_cols = count( $data_arr[0] );
$this->dbl_m_arr =& $data_arr;
return true;
}
/**
* Summates two matrices and returns an object of the sum matrix.
*
* @version 1.0
* @since 0.1.0
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param Matrix $a_obj
* @param Matrix $b_obj
* @return false|Matrix
*/
function summate( &$a_obj, &$b_obj )
{
if (
!is_array( $a_obj->dbl_m_arr )
|| !is_array( $b_obj->dbl_m_arr )
|| !is_array( $a_obj->dbl_m_arr[0] )
|| !is_array( $b_obj->dbl_m_arr[0] )
|| count( $a_obj->dbl_m_arr ) != count( $b_obj->dbl_m_arr )
|| count( $a_obj->dbl_m_arr[0] ) != count( $b_obj->dbl_m_arr[0] )
)
return false;
$out_obj = new Matrix(
count( $a_obj->dbl_m_arr ),
count( $a_obj->dbl_m_arr[0] )
);
for ( $i = 0; $i < count( $a_obj->dbl_m_arr ); $i++ )
for ( $k = 0; $k < count( $b_obj->dbl_m_arr[$i] ); $k++ )
$out_obj->dbl_m_arr[$i][$k]
= $a_obj->dbl_m_arr[$i][$k] + $b_obj->dbl_m_arr[$i][$k];
return $out_obj;
}
/**
* Scales this matrix by the given value.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param double $dbl_factor
* @return void
*/
function scale( $dbl_factor )
{
for ( $i = 0; $i < count( $this->dbl_m_arr ); $i++ )
for ( $k = 0; $k < count( $this->dbl_m_arr[$i] ); $k++ )
$this->dbl_m_arr[$i][$k] *= $dbl_factor;
}
/**
* Swaps two rows in this matrix. The row count begins at 1 (one)! This is an
* elemantary matrix row operation.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $int_row_a
* @param integer $int_row_b
* @return void
*/
function swapRows( $int_row_a, $int_row_b )
{
if ( $int_row_a == $int_row_b )
return false;
$dbl_help_arr = $this->dbl_m_arr[ $int_row_a-1 ];
$this->dbl_m_arr[ $int_row_a-1 ] = $this->dbl_m_arr[ $int_row_b-1 ];
$this->dbl_m_arr[ $int_row_b-1 ] = $dbl_help_arr;
return true;
}
/**
* Scales a row in this matrix. The row count begins at 1 (one)! This is an
* elemantary matrix row operation.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param double $dbl_factor
* @param integer $int_row
* @return boolean
*/
function scaleRow( $dbl_factor, $int_row )
{
if (
!is_numeric ( $dbl_factor )
|| $dbl_factor == 0
|| $dbl_factor == 0.0
)
return false;
foreach ( $this->dbl_m_arr[ $int_row-1 ] as $key => $val )
$this->dbl_m_arr[ $int_row-1 ][ $key ] *= $dbl_factor;
return true;
}
/**
* Scales a row virtually and adds it to another given row in this matrix.
* The row count begins at 1 (one)! This is an elemantary matrix row
* operation.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param double $dbl_factor The scale factor.
* @param integer $int_srow Row to scale.
* @param integer $int_row Row which the scaled row will add with.
* @return boolean
*/
function addScaledRowToAnother( $dbl_factor, $int_srow, $int_row )
{
if ( $int_srow == $int_row )
return false;
$tmp_arr = array();
foreach ( $this->dbl_m_arr[ $int_srow-1 ] as $key => $val )
$tmp_arr[ $key ] = $val * $dbl_factor;
foreach ( $tmp_arr as $key => $val )
$this->dbl_m_arr[ $int_row-1 ][ $key ] += $val;
return true;
}
/**
* Converts this matrix into a reduced row echelon form using the Gaussian
* elimination.
*
* @todo implementing
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param Matrix $a_obj
* @param Matrix $b_obj
* @return false|Matrix
*/
function convertIntoReducedRowEchelonForm()
{
$int_pivo_row = 0;
for (
$k = 0;
$k < count( $this->dbl_m_arr[0] )
&& $int_pivo_row < count( $this->dbl_m_arr );
$k++
)
{
# proof case one
$int_mem = -1;
for ( $i = $int_pivo_row; $i < count( $this->dbl_m_arr ); $i++ )
if ( !($bool_continue = $this->dbl_m_arr[$i][$k] == 0) )
{
$int_mem = $i;
// The left site til column $k+1 of the matrix is NOT in
// reduced row echelon form.
break;
}
if ( $bool_continue )
// The left site til column $k+1 of the matrix IS in reduced row
// echelon form, so we can continue with the next column.
continue;
# proof case two
if ( $this->dbl_m_arr[$int_pivo_row][$k] == 0 )
$this->swapRows( $int_pivo_row+1, $int_mem+1 );
# handle case three
$dbl_factor = 1/$this->dbl_m_arr[$int_pivo_row][$k];
$this->scaleRow( $dbl_factor, $int_pivo_row+1 );
for ( $i = 0; $i < count( $this->dbl_m_arr ); $i++ )
if ( $i != $int_pivo_row )
$this->addScaledRowToAnother(
-$this->dbl_m_arr[$i][$k],
$int_pivo_row+1, $i+1
);
$int_pivo_row++;
}
}
/**
* Multiplies two matrices and returns an object of the product matrix.
*
* @version 1.0
* @since 0.1.0
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param Matrix $a_obj
* @param Matrix $b_obj
* @return false|Matrix
*/
function multiply( &$a_obj, &$b_obj )
{
if (
!is_array( $a_obj->dbl_m_arr[0] )
|| !is_array( $b_obj->dbl_m_arr )
|| count( $a_obj->dbl_m_arr[0] ) != count( $b_obj->dbl_m_arr )
)
return false;
$out_obj = new Matrix(
count( $a_obj->dbl_m_arr ),
count( $b_obj->dbl_m_arr[0] )
);
for ( $i = 0; $i < count( $a_obj->dbl_m_arr ); $i++ )
for ( $k = 0; $k < count( $b_obj->dbl_m_arr[0] ); $k++ )
{
$out_obj->dbl_m_arr[$i][$k] = 0;
for ( $l = 0; $l < count( $b_obj->dbl_m_arr ); $l++ )
// OR for ( $l = 0; $l < count( $a_obj->dbl_m_arr[$i] ); $l++ )
$out_obj->dbl_m_arr[$i][$k]
+= $a_obj->dbl_m_arr[$i][$l] * $b_obj->dbl_m_arr[$l][$k];
}
return $out_obj;
}
/**
* Returns an object of this class which all elements on the diagonal have
* the value 1 (one) and the other elements have the value 0 (zero).
*
* @version 1.0
* @since 0.1.0
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $rows_cols
* @return Matrix
*/
function getIdentityMatrix( $rows_cols )
{
$out_obj = new Matrix( $rows_cols, $rows_cols );
for ( $i = 0; $i < $rows_cols; $i++ )
for ( $k = 0; $k < $rows_cols; $k++ )
if ( $i == $k )
$out_obj->dbl_m_arr[$i][$k] = 1;
else
$out_obj->dbl_m_arr[$i][$k] = 0;
return $out_obj;
}
} // End of class Matrix
?>

Source for file Matrix.class.php