bpp-core  2.2.0
Public Member Functions | List of all members
bpp::Matrix< Scalar > Class Template Referenceabstract

The matrix template interface. More...

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

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

Public Member Functions

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

Detailed Description

template<class Scalar>
class bpp::Matrix< Scalar >

The matrix template interface.

Definition at line 58 of file Matrix.h.

Constructor & Destructor Documentation

◆ Matrix()

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

Definition at line 62 of file Matrix.h.

◆ ~Matrix()

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

Definition at line 63 of file Matrix.h.

Member Function Documentation

◆ clone()

virtual Clonable* bpp::Clonable::clone ( ) const
pure virtualinherited

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

Returns
A pointer toward the copy object.

Implemented in bpp::TestFunction, bpp::InfinityDerivableSecondOrderWrapper, bpp::InfinityDerivableFirstOrderWrapper, bpp::InfinityFunctionWrapper, bpp::LinearMatrix< Scalar >, bpp::StdErr, bpp::FunctionStopCondition, bpp::StdOut, bpp::PlaceboTransformedParameter, bpp::ColMatrix< Scalar >, bpp::StlOutputStreamWrapper, bpp::ParametersStopCondition, bpp::ReparametrizationDerivableSecondOrderWrapper, bpp::IntervalTransformedParameter, bpp::BppUnsignedInteger, bpp::MetaOptimizer, bpp::StlOutputStream, bpp::IntervalConstraint, bpp::DerivableSecondOrder, bpp::Parameter, bpp::RescaledHmmLikelihood, bpp::BppInteger, bpp::LogsumHmmLikelihood, bpp::ReparametrizationDerivableFirstOrderWrapper, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, bpp::RowMatrix< Real >, bpp::BppDouble, bpp::LowMemoryRescaledHmmLikelihood, bpp::Simplex, bpp::NullOutputStream, bpp::RTransformedParameter, bpp::ParametrizableCollection< N >, bpp::DerivableFirstOrder, bpp::Optimizer, bpp::Number< T >, bpp::Number< double >, bpp::Number< int >, bpp::Number< unsigned int >, bpp::DownhillSimplexMethod, bpp::AbstractNumericalDerivative, bpp::SimpleDiscreteDistribution, bpp::ThreePointsNumericalDerivative, bpp::DirichletDiscreteDistribution, bpp::FivePointsNumericalDerivative, bpp::DualityDiagram, bpp::ReparametrizationFunctionWrapper, bpp::PrincipalComponentAnalysis, bpp::TruncatedExponentialDiscreteDistribution, bpp::MetaOptimizerInfos, bpp::MixtureOfDiscreteDistributions, bpp::NewtonBacktrackOneDimension, bpp::AutoParameter, bpp::DataTable, bpp::ParameterListener, bpp::UNode, bpp::InvariantMixedDiscreteDistribution, bpp::AliasParameterListener, bpp::PowellMultiDimensions, bpp::Range< T >, bpp::OutputStream, bpp::BrentOneDimension, bpp::TwoPointsNumericalDerivative, bpp::GammaDiscreteDistribution, bpp::GoldenSectionSearch, bpp::DirectionFunction, bpp::BetaDiscreteDistribution, bpp::ExponentialDiscreteDistribution, bpp::BppVector< TYPE >, bpp::CorrespondenceAnalysis, bpp::Point2D< T >, bpp::BppNotANumber, bpp::BppString, bpp::BasicTNode, bpp::HmmLikelihood, bpp::ParameterList, bpp::ContingencyTableTest, bpp::Font, bpp::BfgsMultiDimensions, bpp::FullHmmTransitionMatrix, bpp::BppBoolean, bpp::TNode, bpp::GaussianDiscreteDistribution, bpp::NewtonBacktrackOneDimension::NBODStopCondition, bpp::OptimizationStopCondition, bpp::ParameterEvent, bpp::UniformDiscreteDistribution, bpp::AutoCorrelationTransitionMatrix, bpp::ConstantDistribution, bpp::DiscreteDistribution, bpp::MultipleDiscreteDistribution, bpp::ConjugateGradientMultiDimensions, bpp::DownhillSimplexMethod::DSMStopCondition, bpp::RGBColor, bpp::BrentOneDimension::BODStopCondition, bpp::ONode, bpp::GoldenSectionSearch::GSSStopCondition, bpp::PowellMultiDimensions::PMDStopCondition, bpp::SimpleMultiDimensions, bpp::SimpleNewtonMultiDimensions, bpp::Constraint, bpp::HmmEmissionProbabilities, bpp::TransformedParameter, bpp::BppNumberI, and bpp::NewtonOneDimension.

◆ col()

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

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

◆ equals()

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

Definition at line 81 of file Matrix.h.

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

◆ getNumberOfColumns()

template<class Scalar>
virtual size_t bpp::Matrix< Scalar >::getNumberOfColumns ( ) const
pure virtual
Returns
The number of columns.

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

Referenced by bpp::ColMatrix< Scalar >::ColMatrix(), bpp::DualityDiagram::compute_(), bpp::MatrixTools::covar(), bpp::Matrix< Scalar >::equals(), bpp::MatrixTools::fill(), bpp::MatrixTools::hadamardMult(), bpp::MatrixTools::isSquare(), bpp::MatrixTools::kroneckerMult(), bpp::MatrixTools::kroneckerSum(), bpp::LinearMatrix< Scalar >::LinearMatrix(), bpp::MatrixTools::max(), bpp::MatrixTools::min(), bpp::RowMatrix< Real >::operator=(), bpp::ColMatrix< Scalar >::operator=(), bpp::LinearMatrix< Scalar >::operator=(), bpp::operator==(), bpp::MatrixTools::print(), bpp::MatrixTools::printForR(), bpp::RowMatrix< Real >::RowMatrix(), bpp::AdaptiveKernelDensityEstimation::sampleMean_(), bpp::MatrixTools::scale(), bpp::MatrixTools::sumElements(), bpp::MatrixTools::toVVdouble(), bpp::MatrixTools::whichMax(), and bpp::MatrixTools::whichMin().

◆ getNumberOfRows()

template<class Scalar>
virtual size_t bpp::Matrix< Scalar >::getNumberOfRows ( ) const
pure virtual
Returns
The number of rows.

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

Referenced by bpp::ColMatrix< Scalar >::ColMatrix(), bpp::DualityDiagram::compute_(), bpp::MatrixTools::covar(), bpp::Matrix< Scalar >::equals(), bpp::MatrixTools::fill(), bpp::MatrixTools::hadamardMult(), bpp::MatrixTools::isSquare(), bpp::MatrixTools::kroneckerMult(), bpp::MatrixTools::kroneckerSum(), bpp::LinearMatrix< Scalar >::LinearMatrix(), bpp::MatrixTools::max(), bpp::MatrixTools::min(), bpp::RowMatrix< Real >::operator=(), bpp::ColMatrix< Scalar >::operator=(), bpp::LinearMatrix< Scalar >::operator=(), bpp::operator==(), bpp::MatrixTools::print(), bpp::MatrixTools::printForR(), bpp::RowMatrix< Real >::RowMatrix(), bpp::AdaptiveKernelDensityEstimation::sampleMean_(), bpp::MatrixTools::scale(), bpp::FullHmmTransitionMatrix::setTransitionProbabilities(), bpp::MatrixTools::sumElements(), bpp::MatrixTools::toVVdouble(), bpp::MatrixTools::whichMax(), and bpp::MatrixTools::whichMin().

◆ operator()() [1/2]

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

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

◆ operator()() [2/2]

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

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

◆ resize()

template<class Scalar>
virtual void bpp::Matrix< Scalar >::resize ( size_t  nRows,
size_t  nCols 
)
pure virtual

Resize the matrix.

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

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

Referenced by bpp::MatrixTools::covar(), bpp::MatrixTools::diag(), bpp::MatrixTools::getId(), bpp::MatrixTools::hadamardMult(), bpp::MatrixTools::kroneckerMult(), bpp::MatrixTools::kroneckerSum(), and bpp::LUDecomposition< Real >::permuteCopy().

◆ row()

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

Implemented in bpp::LinearMatrix< Scalar >, bpp::ColMatrix< Scalar >, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, and bpp::RowMatrix< Real >.

Referenced by bpp::FullHmmTransitionMatrix::setTransitionProbabilities().

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