bpp-phyl  2.2.0
bpp::OptimizationTools::ScaleFunction Class Reference
+ Inheritance diagram for bpp::OptimizationTools::ScaleFunction:
+ Collaboration diagram for bpp::OptimizationTools::ScaleFunction:

Public Member Functions

 ScaleFunction (TreeLikelihood *tl)
 
 ScaleFunction (const ScaleFunction &sf)
 
ScaleFunctionoperator= (const ScaleFunction &sf)
 
virtual ~ScaleFunction ()
 
ScaleFunctionclone () const
 
void setParameters (const ParameterList &lambda) throw (ParameterNotFoundException, ConstraintException)
 
double getValue () const throw (ParameterException)
 
const ParameterList & getParameters () const throw (Exception)
 
const Parameter & getParameter (const std::string &name) const throw (ParameterNotFoundException)
 
double getParameterValue (const std::string &name) const throw (ParameterNotFoundException)
 
size_t getNumberOfParameters () const
 
size_t getNumberOfIndependentParameters () const
 

Private Attributes

TreeLikelihoodtl_
 
ParameterList brLen_
 
ParameterList lambda_
 

Detailed Description

Definition at line 493 of file OptimizationTools.h.

Constructor & Destructor Documentation

◆ ScaleFunction() [1/2]

OptimizationTools::ScaleFunction::ScaleFunction ( TreeLikelihood tl)

Definition at line 77 of file OptimizationTools.cpp.

References brLen_, bpp::TreeLikelihood::getBranchLengthsParameters(), and lambda_.

Referenced by clone().

◆ ScaleFunction() [2/2]

bpp::OptimizationTools::ScaleFunction::ScaleFunction ( const ScaleFunction sf)
inline

Definition at line 504 of file OptimizationTools.h.

◆ ~ScaleFunction()

OptimizationTools::ScaleFunction::~ScaleFunction ( )
virtual

Definition at line 89 of file OptimizationTools.cpp.

Member Function Documentation

◆ clone()

ScaleFunction* bpp::OptimizationTools::ScaleFunction::clone ( ) const
inline

Definition at line 525 of file OptimizationTools.h.

References ScaleFunction().

◆ getNumberOfIndependentParameters()

size_t bpp::OptimizationTools::ScaleFunction::getNumberOfIndependentParameters ( ) const
inline

Definition at line 541 of file OptimizationTools.h.

◆ getNumberOfParameters()

size_t bpp::OptimizationTools::ScaleFunction::getNumberOfParameters ( ) const
inline

Definition at line 540 of file OptimizationTools.h.

◆ getParameter()

const Parameter& bpp::OptimizationTools::ScaleFunction::getParameter ( const std::string &  name) const
throw (ParameterNotFoundException
)
inline

Definition at line 531 of file OptimizationTools.h.

References lambda_.

◆ getParameters()

const ParameterList& bpp::OptimizationTools::ScaleFunction::getParameters ( ) const
throw (Exception
)
inline

Definition at line 530 of file OptimizationTools.h.

References lambda_.

Referenced by bpp::OptimizationTools::optimizeTreeScale().

◆ getParameterValue()

double bpp::OptimizationTools::ScaleFunction::getParameterValue ( const std::string &  name) const
throw (ParameterNotFoundException
)
inline

Definition at line 536 of file OptimizationTools.h.

References lambda_.

◆ getValue()

double OptimizationTools::ScaleFunction::getValue ( ) const
throw (ParameterException
)

Definition at line 99 of file OptimizationTools.cpp.

◆ operator=()

ScaleFunction& bpp::OptimizationTools::ScaleFunction::operator= ( const ScaleFunction sf)
inline

Definition at line 510 of file OptimizationTools.h.

References brLen_, lambda_, and tl_.

◆ setParameters()

void OptimizationTools::ScaleFunction::setParameters ( const ParameterList &  lambda)
throw (ParameterNotFoundException,
ConstraintException
)

Definition at line 91 of file OptimizationTools.cpp.

Member Data Documentation

◆ brLen_

ParameterList bpp::OptimizationTools::ScaleFunction::brLen_
mutableprivate

Definition at line 499 of file OptimizationTools.h.

Referenced by operator=(), and ScaleFunction().

◆ lambda_

ParameterList bpp::OptimizationTools::ScaleFunction::lambda_
mutableprivate

◆ tl_

TreeLikelihood* bpp::OptimizationTools::ScaleFunction::tl_
private

Definition at line 498 of file OptimizationTools.h.

Referenced by operator=().


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