bpp-core  2.2.0
Public Member Functions | Private Attributes | List of all members
bpp::ColMatrix< Scalar > Class Template Reference

Matrix storage by column. More...

#include <Bpp/Numeric/Matrix/Matrix.h>

+ Inheritance diagram for bpp::ColMatrix< Scalar >:
+ Collaboration diagram for bpp::ColMatrix< Scalar >:

Public Member Functions

 ColMatrix ()
 
 ColMatrix (size_t nRow, size_t nCol)
 
 ColMatrix (const Matrix< Scalar > &m)
 
ColMatrix & operator= (const Matrix< Scalar > &m)
 
virtual ~ColMatrix ()
 
ColMatrix * clone () const
 Create a copy of this object and send a pointer to it. More...
 
const Scalar & operator() (size_t i, size_t j) const
 
Scalar & operator() (size_t i, size_t j)
 
size_t getNumberOfColumns () const
 
size_t getNumberOfRows () const
 
std::vector< Scalar > row (size_t i) const
 
const std::vector< Scalar > & getCol (size_t i) const
 
std::vector< Scalar > col (size_t j) const
 
void resize (size_t nRows, size_t nCols)
 Resize the matrix. More...
 
void addCol (const std::vector< Scalar > &newCol) throw (DimensionException)
 
virtual bool equals (const Matrix &m, double threshold=NumConstants::TINY())
 

Private Attributes

std::vector< std::vector< Scalar > > m_
 

Detailed Description

template<class Scalar>
class bpp::ColMatrix< Scalar >

Matrix storage by column.

This matrix is a vector of vector of Scalar. Column access is in $O(1)$ while row access is in $O(nCol)$.

Definition at line 232 of file Matrix.h.

Constructor & Destructor Documentation

◆ ColMatrix() [1/3]

template<class Scalar>
bpp::ColMatrix< Scalar >::ColMatrix ( )
inline

Definition at line 239 of file Matrix.h.

Referenced by bpp::ColMatrix< Scalar >::clone().

◆ ColMatrix() [2/3]

template<class Scalar>
bpp::ColMatrix< Scalar >::ColMatrix ( size_t  nRow,
size_t  nCol 
)
inline

Definition at line 241 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

◆ ColMatrix() [3/3]

template<class Scalar>
bpp::ColMatrix< Scalar >::ColMatrix ( const Matrix< Scalar > &  m)
inline

Definition at line 249 of file Matrix.h.

References bpp::Matrix< Scalar >::getNumberOfColumns(), bpp::Matrix< Scalar >::getNumberOfRows(), and bpp::ColMatrix< Scalar >::m_.

◆ ~ColMatrix()

template<class Scalar>
virtual bpp::ColMatrix< Scalar >::~ColMatrix ( )
inlinevirtual

Definition at line 279 of file Matrix.h.

Member Function Documentation

◆ addCol()

template<class Scalar>
void bpp::ColMatrix< Scalar >::addCol ( const std::vector< Scalar > &  newCol)
throw (DimensionException
)
inline

Definition at line 320 of file Matrix.h.

References bpp::ColMatrix< Scalar >::getNumberOfRows(), and bpp::ColMatrix< Scalar >::m_.

◆ clone()

template<class Scalar>
ColMatrix* bpp::ColMatrix< Scalar >::clone ( ) const
inlinevirtual

Create a copy of this object and send a pointer to it.

Returns
A pointer toward the copy object.

Implements bpp::Clonable.

Definition at line 282 of file Matrix.h.

References bpp::ColMatrix< Scalar >::ColMatrix().

◆ col()

template<class Scalar>
std::vector<Scalar> bpp::ColMatrix< Scalar >::col ( size_t  j) const
inlinevirtual
Returns
the column at position j as a vector.
Parameters
jThe index of the column.

Implements bpp::Matrix< Scalar >.

Definition at line 304 of file Matrix.h.

References bpp::ColMatrix< Scalar >::getNumberOfRows(), and bpp::ColMatrix< Scalar >::operator()().

◆ equals()

template<class Scalar>
virtual bool bpp::Matrix< Scalar >::equals ( const Matrix< Scalar > &  m,
double  threshold = NumConstants::TINY() 
)
inlinevirtualinherited

Definition at line 81 of file Matrix.h.

References bpp::Matrix< Scalar >::getNumberOfColumns(), and bpp::Matrix< Scalar >::getNumberOfRows().

◆ getCol()

template<class Scalar>
const std::vector<Scalar>& bpp::ColMatrix< Scalar >::getCol ( size_t  i) const
inline

Definition at line 299 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

◆ getNumberOfColumns()

template<class Scalar>
size_t bpp::ColMatrix< Scalar >::getNumberOfColumns ( ) const
inlinevirtual
Returns
The number of columns.

Implements bpp::Matrix< Scalar >.

Definition at line 288 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

Referenced by bpp::ColMatrix< Scalar >::row().

◆ getNumberOfRows()

template<class Scalar>
size_t bpp::ColMatrix< Scalar >::getNumberOfRows ( ) const
inlinevirtual
Returns
The number of rows.

Implements bpp::Matrix< Scalar >.

Definition at line 290 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

Referenced by bpp::ColMatrix< Scalar >::addCol(), and bpp::ColMatrix< Scalar >::col().

◆ operator()() [1/2]

template<class Scalar>
const Scalar& bpp::ColMatrix< Scalar >::operator() ( size_t  i,
size_t  j 
) const
inlinevirtual
Returns
$m_{i,j}$.
Parameters
irow index.
jcolumn index.

Implements bpp::Matrix< Scalar >.

Definition at line 284 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

Referenced by bpp::ColMatrix< Scalar >::col(), and bpp::ColMatrix< Scalar >::row().

◆ operator()() [2/2]

template<class Scalar>
Scalar& bpp::ColMatrix< Scalar >::operator() ( size_t  i,
size_t  j 
)
inlinevirtual
Returns
$m_{i,j}$.
Parameters
irow index.
jcolumn index.

Implements bpp::Matrix< Scalar >.

Definition at line 286 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

◆ operator=()

template<class Scalar>
ColMatrix& bpp::ColMatrix< Scalar >::operator= ( const Matrix< Scalar > &  m)
inline

Definition at line 263 of file Matrix.h.

References bpp::Matrix< Scalar >::getNumberOfColumns(), bpp::Matrix< Scalar >::getNumberOfRows(), and bpp::ColMatrix< Scalar >::m_.

◆ resize()

template<class Scalar>
void bpp::ColMatrix< Scalar >::resize ( size_t  nRows,
size_t  nCols 
)
inlinevirtual

Resize the matrix.

Parameters
nRowsThe new number of rows.
nColsThe new number of columns.

Implements bpp::Matrix< Scalar >.

Definition at line 311 of file Matrix.h.

References bpp::ColMatrix< Scalar >::m_.

◆ row()

template<class Scalar>
std::vector<Scalar> bpp::ColMatrix< Scalar >::row ( size_t  i) const
inlinevirtual
Returns
the row at position i as a vector.
Parameters
iThe index of the row.

Implements bpp::Matrix< Scalar >.

Definition at line 292 of file Matrix.h.

References bpp::ColMatrix< Scalar >::getNumberOfColumns(), and bpp::ColMatrix< Scalar >::operator()().

Member Data Documentation

◆ m_

template<class Scalar>
std::vector< std::vector<Scalar> > bpp::ColMatrix< Scalar >::m_
private

Definition at line 236 of file Matrix.h.

Referenced by bpp::ColMatrix< Scalar >::addCol(), bpp::ColMatrix< Scalar >::ColMatrix(), bpp::ColMatrix< Scalar >::getCol(), bpp::ColMatrix< Scalar >::getNumberOfColumns(), bpp::ColMatrix< Scalar >::getNumberOfRows(), bpp::ColMatrix< Scalar >::operator()(), bpp::ColMatrix< Scalar >::operator=(), and bpp::ColMatrix< Scalar >::resize().

The documentation for this class was generated from the following file: