bpp::Matrix< Scalar > Class Template Reference

The matrix template interface. More...

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

Inheritance diagram for bpp::Matrix< Scalar >:

Collaboration diagram for bpp::Matrix< Scalar >:

List of all members.

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.
virtual Clonable *	clone () const =0
	Create a copy of this object and send a pointer to it.

---

Detailed Description

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

The matrix template interface.

Definition at line 58 of file Matrix.h.

---

Constructor & Destructor Documentation

template<class Scalar>

bpp::Matrix< Scalar >::Matrix

(

)

[inline]

Definition at line 62 of file Matrix.h.

template<class Scalar>

virtual bpp::Matrix< Scalar >::~Matrix

(

)

[inline, virtual]

Definition at line 63 of file Matrix.h.

---

Member Function Documentation

virtual Clonable* bpp::Clonable::clone

(

)

const [pure virtual, inherited]

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::StdErr, bpp::FunctionStopCondition, bpp::StdOut, bpp::LinearMatrix< Scalar >, bpp::PlaceboTransformedParameter, bpp::StlOutputStreamWrapper, bpp::ParametersStopCondition, bpp::ReparametrizationDerivableSecondOrderWrapper, bpp::IntervalTransformedParameter, bpp::MetaOptimizer, bpp::StlOutputStream, bpp::DerivableSecondOrder, bpp::Parameter, bpp::ReparametrizationDerivableFirstOrderWrapper, bpp::IntervalConstraint, bpp::RowMatrix< Scalar >, bpp::RowMatrix< double >, bpp::RowMatrix< Real >, bpp::LowMemoryRescaledHmmLikelihood, bpp::NullOutputStream, bpp::LogsumHmmLikelihood, bpp::Simplex, bpp::RTransformedParameter, bpp::RescaledHmmLikelihood, bpp::DerivableFirstOrder, bpp::Optimizer, bpp::DownhillSimplexMethod, bpp::AbstractNumericalDerivative, bpp::SimpleDiscreteDistribution, bpp::DirichletDiscreteDistribution, bpp::DualityDiagram, bpp::ReparametrizationFunctionWrapper, bpp::PrincipalComponentAnalysis, bpp::TruncatedExponentialDiscreteDistribution, bpp::DataTable, bpp::MetaOptimizerInfos, bpp::MixtureOfDiscreteDistributions, bpp::NewtonBacktrackOneDimension, bpp::AutoParameter, bpp::FivePointsNumericalDerivative, bpp::ParameterListener, bpp::ThreePointsNumericalDerivative, bpp::UNode, bpp::InvariantMixedDiscreteDistribution, bpp::AliasParameterListener, bpp::PowellMultiDimensions, bpp::Range< T >, bpp::OutputStream, bpp::BrentOneDimension, bpp::GammaDiscreteDistribution, bpp::GoldenSectionSearch, bpp::DirectionFunction, bpp::TwoPointsNumericalDerivative, bpp::BetaDiscreteDistribution, bpp::ExponentialDiscreteDistribution, bpp::BppVector< TYPE >, bpp::CorrespondenceAnalysis, bpp::Point2D< T >, bpp::Number< T >, bpp::BppString, bpp::BasicTNode, bpp::ParameterList, bpp::ContingencyTableTest, bpp::Font, bpp::BfgsMultiDimensions, bpp::BppBoolean, bpp::TNode, bpp::HmmLikelihood, bpp::GaussianDiscreteDistribution, bpp::NewtonBacktrackOneDimension::NBODStopCondition, bpp::OptimizationStopCondition, bpp::ParameterEvent, bpp::UniformDiscreteDistribution, 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::HmmEmissionProbabilities, bpp::Constraint, bpp::TransformedParameter, and bpp::NewtonOneDimension.

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:

j	The index of the column.

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

template<class Scalar>

virtual bool bpp::Matrix< Scalar >::equals	(	const Matrix< Scalar > &	m,
		double	threshold = NumConstants::TINY()
	)		[inline, virtual]

Definition at line 79 of file Matrix.h.

template<class Scalar>

virtual size_t bpp::Matrix< Scalar >::getNumberOfColumns

(

)

const [pure virtual]

Returns:

The number of columns.

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

Referenced by bpp::DualityDiagram::compute_(), bpp::MatrixTools::covar(), bpp::Matrix< Real >::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::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::Taylor(), bpp::MatrixTools::toVVdouble(), bpp::MatrixTools::whichMax(), and bpp::MatrixTools::whichMin().

template<class Scalar>

virtual size_t bpp::Matrix< Scalar >::getNumberOfRows

(

)

const [pure virtual]

Returns:

The number of rows.

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

Referenced by bpp::DualityDiagram::compute_(), bpp::MatrixTools::covar(), bpp::Matrix< Real >::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::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::Taylor(), bpp::MatrixTools::toVVdouble(), bpp::MatrixTools::whichMax(), and bpp::MatrixTools::whichMin().

template<class Scalar>

virtual const Scalar& bpp::Matrix< Scalar >::operator()	(	size_t	i,
		size_t	j
	)		const [pure virtual]

Returns:

.

Parameters:

i	row index.
j	column index.

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

template<class Scalar>

virtual Scalar& bpp::Matrix< Scalar >::operator()	(	size_t	i,
		size_t	j
	)		[pure virtual]

Returns:

.

Parameters:

i	row index.
j	column index.

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

template<class Scalar>

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

Resize the matrix.

Parameters:

nRows	The new number of rows.
nCols	The new number of columns.

Implemented in bpp::LinearMatrix< 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().

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:

i	The index of the row.

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

---

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

• Bpp/Numeric/Matrix/Matrix.h