Yuito Takeuchi
nanimo kaete nai
Diff: Matrix.h
- Revision:
- 0:4ff90c5befd9
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Matrix.h Tue Jun 14 07:37:36 2022 +0000
@@ -0,0 +1,425 @@
+/**
+ * @brief API for Matrix Library
+ * @file Matrix.h
+ * @author Ernesto Palacios
+ *
+ * Created on 13 de septiembre de 2011, 03:49 PM
+ *
+ * Develop Under GPL v3.0 License
+ * http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ */
+
+#ifndef MATRIX_H
+#define MATRIX_H
+
+
+#include <vector>
+
+using namespace std;
+
+class MatrixMath;
+
+/**
+ * @brief This class provide basic manipulation for 2D matrices see Log.c for more info
+ * version 1.6.4.
+ *
+ */
+class Matrix{
+public:
+
+ /// Creates a nex Matrix of Size [ Row x Cols ]
+ Matrix( int Rows, int Cols );
+
+
+ /// Creates a new Matrix identical to an input Matrix
+ Matrix( const Matrix& base );
+
+
+ /// Default Constructor
+ Matrix();
+
+
+/******************************************************************************/
+
+
+ /**@brief This includes the Class to handle Matrix Operations.
+ */
+ friend class MatrixMath;
+
+
+ /**@brief
+ * Subindex for Matrix elements assignation.
+ * @param row
+ * @param col
+ * @return pointer to the element.
+ */
+ float& operator() ( int row, int col );
+
+
+ /**@brief
+ *Subindex for Matrix element.
+ * @param row
+ * @param col
+ * @return the element.
+ */
+ float operator() ( int row, int col ) const;
+
+
+
+ /** @brief
+ * Overwrites all data. To be used Carefully!
+ */
+ Matrix& operator = ( const Matrix& rightM );
+
+
+ /** @brief
+ * Overload opeartor for the compare Matrices
+ *
+ * @param rightM
+ * @return Boolean 'false' if different.
+ */
+ friend bool operator == ( const Matrix& leftM, const Matrix& rightM );
+
+
+ /** @brief
+ * Overload opeartor for the compare Matrices
+ *
+ * @param rightM
+ * @return Boolean 'true' if different
+ */
+ friend bool operator != ( const Matrix& leftM, const Matrix& rightM );
+
+
+ /** @brief
+ * Overload Copmpound assignment.
+ * @param rightM
+ * @return A new Matrix to be assigned to itself.
+ */
+ friend Matrix& operator += ( Matrix& leftM, const Matrix& rightM );
+
+
+ /** @brief
+ * Overload Compund decrease.
+ * @param rightM Right hand matrix
+ * @return A new Matrix to be assigned to itself
+ */
+ friend Matrix& operator -= ( Matrix& leftM, const Matrix& rightM );
+
+
+ /** @brief
+ * Overload Compound CrossProduct Matrix operation.
+ * @param rightM
+ * @return
+ */
+ friend Matrix& operator *=( Matrix& leftM, const Matrix& rightM );
+
+
+ /** @brief
+ * Overload Compund Element-by-elemnt scalar multiplication.
+ * @param number
+ * @return
+ */
+ friend Matrix& operator *=( Matrix& leftM, float number );
+
+
+
+ /**@brief
+ * All elements in matrix are multiplied by (-1).
+ * @return A new Matrix object with inverted values.
+ */
+ const Matrix operator -();
+
+
+ /**@brief
+ * Overload Compound add with scalar.
+ * Because the '=' operator checks for self Assign, no extra operations
+ * are needed.
+ * @return Same Matrix to self Assign.
+ */
+ friend const Matrix operator +=( Matrix& leftM, float number );
+
+
+ /**@brief
+ * Compound substract with scalar.
+ * @return Same matrix to self Assign.
+ */
+ friend const Matrix operator -=( Matrix& leftM, float number );
+
+
+ /** @brief
+ * Adds two matrices of the same dimensions, element-by-element.
+ * If diferent dimensions -> ERROR.
+ * @return A new object Matrix with the result.
+ */
+ friend const Matrix operator +( const Matrix& leftM, const Matrix& rightM);
+
+
+ /** @brief
+ * Adds the given nomber to each element of matrix.
+ * Mimic MATLAB operation.
+ * @return A new matrix object with the result.
+ */
+ friend const Matrix operator +( const Matrix& leftM, float number );
+
+
+
+ /**@brief
+ * Adds the given number to each element in Matrix.
+ * @return A new Matrix object with the result.
+ */
+ friend const Matrix operator +( float number, const Matrix& leftM );
+
+
+ /**@brief
+ * Substracts two matrices of the same size, element-by-element.
+ * If different dimensions -> ERROR.
+ * @return A new object Matrix with the result.
+ */
+ friend const Matrix operator -( const Matrix& leftM, const Matrix& rightM );
+
+
+ /**@brief
+ * Substracts each element in Matrix by number.
+ * @return A new matrix object with the result.
+ */
+ friend const Matrix operator -( const Matrix& leftM, float number );
+
+
+ /**@brief
+ * Substracts each element in Matrix by number
+ * @return A new matrix object with the result.
+ */
+ friend const Matrix operator -( float number, const Matrix& leftM );
+
+
+ /**
+ * Preforms Crossproduct between two matrices.
+ * @return
+ */
+ friend const Matrix operator *( const Matrix& leftM, const Matrix& rightM );
+
+
+ /**@brief
+ * Multiplies a scalar number with each element on Matrix.
+ * @return A new object with the result.
+ */
+ friend const Matrix operator *( const Matrix& leftM, float number );
+
+
+ /**@brief
+ * Multiplies a scalar number with each element on Matrix.
+ * @return
+ */
+ friend const Matrix operator *( float number, const Matrix& leftM );
+
+
+ /**@brief
+ * Inputs numbres into a Matrix, the matrix needs to be costructed as
+ * Matrix( _nRows, _nCols ).
+ * This does NOT work on an only declared Matrix such as:
+ * Matrix obj;
+ * obj << 5; //Error
+ * @return
+ */
+ friend Matrix& operator <<( Matrix& leftM, float number );
+
+/***********************************************************************/
+
+ /** @brief
+ * Returns TRUE if the matrix is zero, FALSE otherwhise
+ * @param mat: Matrix to be tested
+ */
+ bool isZero() const;
+
+
+ /** @brief
+ * Determines weather a Matrix is a Single Column or Row.
+ */
+ bool isVector() const;
+
+
+ /** @brief
+ * Shatters the matrix into a single Row Vector.
+ * Important: Returns NEW matrix, does no modify existing one.
+ */
+ static const Matrix ToPackedVector( const Matrix& Mat );
+
+
+ /** @brief
+ * Invoking this static method will increase a Row in Mat in the desired
+ * position.
+ * The current Row will be moved down to allocate space, and all elements will
+ * be initialized to zero in the new row.
+ * @param Mat: Matrix in wich to insert a Row
+ * @param Row: Number of row to insert, starts with one, not zero.
+ */
+ static void AddRow( Matrix& Mat, int index );
+
+
+ /**@brief
+ * Adds to Receip a new Row from another Matrix in desired index.
+ * Must be same size.
+ * The Row matrix must be SingleRow Matrix, you can use ExportRow
+ * to extract a Row from another Matrix.
+ * @param Receip Matrix to be Modified.
+ * @param Row Row to be added.
+ * @param index position in wich to be added, _nRow + 1 last position.
+ */
+ static void AddRow( Matrix& Receip, const Matrix& Row, int index );
+
+
+ /** @brief
+ * Invoking this static method will increase a Column in Matrix in the
+ * desired Position.
+ * @param Mat: Matrix in wich to insert a Column
+ * @param Col: Number of column, strats with one, not zero.
+ */
+ static void AddCol( Matrix& Mat, int index );
+
+
+ /**@brief
+ * This will copy a Column Matrix into Receip in desired Position,
+ * Must be same size.
+ * The Col Matrix must be a SingleCol Matrix, you can use ExportCol
+ * to extract a Column from another Matrix.
+ * @param Receip Matrix to be modified.
+ * @param Column Data to be copied.
+ * @param index Postion in Receip Matrix .
+ */
+ static void AddCol( Matrix& Receip, const Matrix& Col, int index );
+
+
+ /** @brief
+ * Static Function Deletes Row from Matrix, Static to prevent missuse
+ * @param Mat: Matrix to delete Row from
+ * @param Row: Number of Row (first Row = 1)
+ */
+ static void DeleteRow( Matrix& Mat, int Row );
+
+
+ /** @brief
+ * Static Function Deletes Column from Matrix, it's Static to prevent
+ * missuse.
+ * Print error and does nothing if out of limits.
+ * @param Col: Number of Col to delete (first Col = 1)
+ * @param Mat: Matrix to delete from.
+ */
+ static void DeleteCol( Matrix& Mat, int Col );
+
+
+ /** @brief
+ * This method extracts a Row from a Matrix and Saves it in Mat.
+ * If Row is out of the parameters it does nothing, but prints a warning.
+ * @param Row: number of row to extract elements. this->_nRows.
+ * @param Mat: Matrix to extract from.
+ * @return New Row Matrix.
+ */
+ static const Matrix ExportRow( const Matrix& Mat, int row );
+
+
+ /** @brief
+ * This method extracts a Column from a Matrix and returns the Column
+ * as a new Matrix.
+ * If Row is out of the parameters, it does nothing and prints a warning.
+ * @param Col: number of Column to extract elements. this->_nCols.
+ * @param Mat: Matrix to extract from.
+ * @return New Row Matrix.
+ */
+ static const Matrix ExportCol( const Matrix& Mat, int col );
+
+
+ /** @brief
+ * This function resizes the Matrix to fit new data or cropped it,
+ * operator << can overwrite entire Matrix.
+ *
+ * @param Rows: New Number of Rows
+ * @param Cols: New numbler of columns
+ */
+ void Resize( int Rows, int Cols );
+
+
+ /** @brief
+ * Asks user for numbers to fill the Matrix elements, one by one.
+ * It uses printf(); by default the USBTX, USBRX, 9600, 1N8.
+ */
+ virtual void FillMatrix();
+
+
+ /** @brief
+ * Prints the entire Matrix using standard PRINTF
+ */
+ virtual void print() const;
+
+
+ /** @brief
+ * Makes all values on Matrix object zero.
+ * Also make posible use the '<<' operator to add elements and keep
+ * track of last element added.
+ */
+ void Clear();
+
+
+ /** @brief
+ * Assigns a float number to the matrix in a specified position
+ * Index starts at [1][1].
+ *
+ * @param number: Number to be set
+ * @param Row: Row of Matrix
+ * @param Col: Column of Matrix
+ */
+ void add( int Row, int Col, float number );
+
+
+ /** @brief
+ * Returns the sum of every cell in the Matrix.
+ */
+ float sum() const;
+
+
+ /** @brief
+ * Return the number in position [Row],[Col]
+ * @param Row = number of row in matrix
+ * @param Col = number of Col in matrix
+ * @return Num = float number in matrix
+ */
+ float getNumber( int Row, int Col ) const;
+
+
+ /**@brief
+ * Retuns the number of Columns in Matrix, index starts at 1.
+ */
+ int getCols() const;
+
+
+ /**@brief
+ *Retruns the number of Rows in Matrix, index starts at 1.
+ */
+ int getRows() const;
+
+
+private:
+
+ /** 2-D Vector Array*/
+ vector < vector<float> > _matrix;
+
+
+
+ /** Number of Rows in Matrix*/
+ int _nRows;
+
+ /**Number of Columns in Matrix*/
+ int _nCols;
+
+
+
+ /**Last Element Row position in Matrix*/
+ int _pRow;
+
+ /**Last Element Col position in Matrix*/
+ int _pCol;
+
+};
+
+#endif /* MATRIX_H */
+