matrix.hpp

Go to the documentation of this file.

#ifndef ODP_MATRIX_HPP
#define ODP_MATRIX_HPP

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

// System header files
#include <iostream>

// CPL header files
#include "cpl_matrix.h"

// Local header files
#include "cppcpl/error.hpp"


namespace odp {
  class Matrix : virtual public odp::Error
  {
  public:
   Matrix();

    explicit Matrix(const Matrix &matrix);

    explicit Matrix(cpl_size rows, cpl_size cols);

    virtual ~Matrix();

    inline bool          IsMatrix()                              const;

    void                 GetMatrixPtr(void **data_ptr)            const;

    inline void*         GetMatrixPtr()                          const;

    inline cpl_matrix*   GetCplMatrix()                          const;

    inline void          SetCplMatrix(cpl_matrix *matrix);

    inline cpl_size      GetNumCols() const;

    inline cpl_size      GetNumRows() const;

    void Get(cpl_size  row,
             cpl_size  col,
             double *value) const;

    double Get(cpl_size  row,
               cpl_size  col);

    void Set(cpl_size  row,
             cpl_size  col,
             double value);

    std::string GetSize() const;

    Matrix& Sqrt(const Matrix& matrix);

    void Product(const Matrix&, Matrix *product);

    void Transpose(Matrix *transpose);

    void Solve(const Matrix&, Matrix *solved);

    void SolveNormal(const Matrix&, Matrix *solved);

    void Invert(Matrix *inverse);

    void Append(const Matrix& matrix, int mode);
    
    bool    IsDiagonal(const double tolerance);

    bool    IsIdentity(const double tolerance);

    bool    IsZero(const double tolerance);

    // Object operators

    Matrix& operator+(const double);

    Matrix& operator+(const Matrix&);

    Matrix& operator-(const double);

    Matrix& operator-(const Matrix&);

    Matrix& operator/(const double);

    Matrix& operator/(const Matrix&);

    Matrix& operator*(const double);

    Matrix& operator*(const Matrix&);

    Matrix& operator+=(const double);

    Matrix& operator+=(const Matrix&);

    Matrix& operator-=(const double);

    Matrix& operator-=(const Matrix&);

    Matrix& operator/=(const double);

    Matrix& operator/=(const Matrix&);

    Matrix& operator*=(const double);

    Matrix& operator*=(const Matrix&);

    Matrix& operator=(const Matrix&);

    bool operator==(const Matrix&) const;

    bool operator!=(const Matrix&) const;

    friend std::ostream& operator<<(std::ostream &os, const Matrix &matrix);

  private:
    void Delete();

  protected:
    cpl_matrix   *m_cpl_matrix;

  };

}
#include "matrix.ipp"

#endif