r = variable_value. More...

#include <Bpp/Phyl/Likelihood/DataFlow/DataFlowNumeric.h>

Inheritance diagram for bpp::NumericMutable< T >:

Collaboration diagram for bpp::NumericMutable< T >:

Public Types
using	Self = NumericMutable

Public Member Functions
template<typename ... Args>
	NumericMutable (Args &&... args)

void	setValue (const T &t)
	Setter with invalidation. More...

void	setValue (T &&t)
	Setter with invalidation (movable value version). More...

std::string	debugInfo () const override
	Node debug info (default = ""): user defined detailed info for DF graph debug. More...

std::string	description () const override
	Node pretty name (default = type name). More...

NodeRef	derive (Context &c, const Node_DF &node) final
	Returns a node computing d(this_node_expression)/d(node_expression). More...

NodeRef	recreate (Context &, NodeRefVec &&deps) final
	Recreate the node with different dependencies. More...

const T &	targetValue ()
	Access value, recompute if needed. More...

const T &	accessValueConst () const noexcept
	Raw value access (const). More...

ValueRef< T >	deriveAsValue (Context &c, const Node_DF &node)

template<typename Callable >
void	modify (Callable &&modifier, bool makeValid)
	General case for modification of the T object. More...

bool	isValid () const noexcept

std::size_t	nbDependentNodes () const noexcept
	Number of dependent nodes (ie nodes that depend on this) More...

const std::vector< Node_DF * > &	dependentNodes () const noexcept

std::size_t	nbDependencies () const noexcept
	Number of dependencies (ie nodes we depend on) More...

const NodeRefVec &	dependencies () const noexcept

const NodeRef &	dependency (std::size_t i) const noexcept

virtual std::string	color () const

virtual std::string	shape () const

virtual bool	hasNumericalProperty (NumericalProperty prop) const
	Test if the node has the given numerical property. More...

virtual bool	compareAdditionalArguments (const Node_DF &other) const
	Compare node-specific configuration to another. More...

virtual std::size_t	hashAdditionalArguments () const
	Return the hash of node-specific configuration. More...

void	computeRecursively ()
	Compute this node value, recomputing dependencies (transitively) as needed. More...

Static Public Member Functions
template<typename ... Args>
static std::shared_ptr< Self >	create (Context &, Args &&... args)
	Build a new NumericMutable node with T(args...) value. More...

Protected Member Functions
T &	accessValueMutable () noexcept

void	invalidateRecursively () noexcept
	Invalidate (transitively) dependent nodes from this one. More...

void	makeInvalid () noexcept

void	makeValid () noexcept

void	resetDependencies_ (NodeRefVec &&dependenciesArg)

Private Member Functions
void	compute () final
	Computation implementation. More...

void	registerNode (Node_DF *n)

void	unregisterNode (const Node_DF *n)

Private Attributes
T	value_

NodeRefVec	dependencyNodes_ {}

std::vector< Node_DF * >	dependentNodes_ {}

bool	isValid_ {false}

Detailed Description

template<typename T>
class bpp::NumericMutable< T >

r = variable_value.

r: T.

Value is set at construction, and can be changed (will invalidate all dependent values). Node construction should be done with the create static method. Supports derivation. This node has no Context merging support: mutable nodes are always different.

Definition at line 1206 of file DataFlowNumeric.h.

Member Typedef Documentation

◆ Self

template<typename T >

using bpp::NumericMutable< T >::Self = NumericMutable

Definition at line 1209 of file DataFlowNumeric.h.

Constructor & Destructor Documentation

◆ NumericMutable()

template<typename T >

template<typename ... Args>

bpp::NumericMutable< T >::NumericMutable ( Args &&... args )

inlineexplicit

Definition at line 1218 of file DataFlowNumeric.h.

References bpp::Node_DF::makeValid().

Member Function Documentation

◆ accessValueConst()

template<typename T >

const T& bpp::Value< T >::accessValueConst ( ) const

inlinenoexceptinherited

Raw value access (const).

Value is not guaranteed to be valid (no recomputation).

Definition at line 385 of file DataFlow.h.

References bpp::Value< T >::value_.

Referenced by bpp::NumericConstant< T >::compareAdditionalArguments(), bpp::NumericConstant< T >::debugInfo(), bpp::NumericMutable< T >::debugInfo(), bpp::Convert< R, F >::debugInfo(), bpp::Identity< R >::debugInfo(), bpp::NumericConstant< T >::derive(), bpp::NumericMutable< T >::derive(), bpp::NumericConstant< T >::description(), bpp::NumericMutable< T >::description(), bpp::NumericConstant< T >::hashAdditionalArguments(), bpp::NumericConstant< T >::hasNumericalProperty(), and bpp::Value< T >::targetValue().

◆ accessValueMutable()

template<typename T >

T& bpp::Value< T >::accessValueMutable ( )

inlineprotectednoexceptinherited

Raw value access (mutable). Should only be used by subclasses to implement compute().

Definition at line 416 of file DataFlow.h.

References bpp::Value< T >::value_.

Referenced by bpp::ConstantZero< T >::compute(), bpp::ConstantOne< T >::compute(), bpp::Convert< R, F >::compute(), bpp::Identity< R >::compute(), and bpp::Value< T >::modify().

◆ color()

virtual std::string bpp::Node_DF::color ( ) const

inlinevirtualinherited

Reimplemented in bpp::Sequence_DF, bpp::ShiftParameter, bpp::ConfiguredParameter, bpp::NumericConstant< T >, bpp::MatrixProduct< R, T0, T1 >, bpp::CWiseDiv< R, std::tuple< T0, T1 > >, bpp::CWiseMul< R, std::tuple< T0, T1 > >, bpp::CWiseMean< R, ReductionOf< T >, P >, bpp::CWiseMean< R, ReductionOf< T >, ReductionOf >, bpp::CWiseAdd< R, std::tuple< T0, T1 > >, bpp::CWiseApply< R, T, F >, bpp::TransitionMatrixFromTransitionMatrix, bpp::EquilibriumFrequenciesFromTransitionMatrix, bpp::ConfiguredTransitionMatrix, bpp::FrequenciesFromSimplex, bpp::ConfiguredSimplex, bpp::ProbabilityFromMixedModel, bpp::ProbabilitiesFromMixedModel, bpp::TransitionFunctionFromModel, bpp::TransitionMatrixFromModel, bpp::EquilibriumFrequenciesFromModel, bpp::ConfiguredModel, bpp::FrequenciesFromFrequencySet, bpp::ConfiguredFrequencySet, bpp::CategoryFromDiscreteDistribution, bpp::ProbabilityFromDiscreteDistribution, bpp::ProbabilitiesFromDiscreteDistribution, bpp::ConfiguredDistribution, and bpp::ValueFromConfiguredParameter.

Definition at line 190 of file DataFlow.h.

Referenced by bpp::writeDotEdge(), and bpp::writeDotNode().

◆ compareAdditionalArguments()

bool bpp::Node_DF::compareAdditionalArguments ( const Node_DF & other ) const

virtualinherited

Compare node-specific configuration to another.

Required by Context for merging. It must compare everything in the node configuration except its type and dependencies. See DataFlowNumeric for examples. The default returns false, so nodes are considered different and not merged.

Reimplemented in bpp::Sequence_DF, bpp::ConfiguredParameter, bpp::ConfiguredModel, bpp::NumericConstant< T >, bpp::BackwardHmmLikelihood_DF, bpp::ForwardHmmD2Likelihood_DF, bpp::ForwardHmmDLikelihood_DF, bpp::ForwardHmmLikelihood_DF, bpp::CondLikelihood, bpp::FrequenciesFromSimplex, bpp::ValueFromConfiguredParameter, bpp::ShiftParameter, bpp::ProbabilityFromMixedModel, bpp::ProbabilitiesFromMixedModel, bpp::FrequenciesFromFrequencySet, bpp::CategoryFromDiscreteDistribution, bpp::ProbabilityFromDiscreteDistribution, bpp::ProbabilitiesFromDiscreteDistribution, bpp::Identity< R >, bpp::Convert< R, F >, bpp::ConstantOne< T >, bpp::ConstantZero< T >, bpp::CombineDeltaShifted< T >, bpp::ShiftDelta< T >, bpp::MatrixProduct< R, T0, T1 >, bpp::LogSumExp< R, T0, T1 >, bpp::SumOfLogarithms< F >, bpp::ScalarProduct< R, T0, T1 >, bpp::CWiseConstantPow< T >, bpp::CWiseExp< T >, bpp::CWiseLog< T >, bpp::CWiseInverse< T >, bpp::CWiseNegate< T >, bpp::CWiseDiv< R, std::tuple< T0, T1 > >, bpp::CWiseMul< R, ReductionOf< T > >, bpp::CWiseMul< R, std::tuple< T0, T1 > >, bpp::CWiseMean< R, ReductionOf< T >, P >, bpp::CWiseMean< R, ReductionOf< T >, ReductionOf >, bpp::CWiseAdd< R, T >, bpp::CWiseAdd< R, ReductionOf< T > >, bpp::CWiseSub< R, std::tuple< T0, T1 > >, bpp::CWiseAdd< R, std::tuple< T0, T1 > >, bpp::CWiseApply< R, T, F >, bpp::CWiseCompound< R, ReductionOf< T > >, bpp::CWiseMatching< R, ReductionOf< T > >, bpp::CWisePattern< R >, bpp::CWiseFill< R, T >, bpp::TransitionMatrixFromTransitionMatrix, bpp::EquilibriumFrequenciesFromTransitionMatrix, bpp::ConfiguredTransitionMatrix, bpp::ConfiguredSimplex, bpp::TransitionFunctionFromModel, bpp::TransitionMatrixFromModel, bpp::EquilibriumFrequenciesFromModel, bpp::ConfiguredFrequencySet, and bpp::ConfiguredDistribution.

Definition at line 170 of file DataFlow.cpp.

◆ compute()

template<typename T >

void bpp::NumericMutable< T >::compute ( )

inlinefinalprivatevirtual

Computation implementation.

This functions is defined by derived classes. It should compute the new node value from dependency node values. When called, dependency node are guaranteed to have valid values.

This function is private to prevent use for invalid dependencies. Higher level functions like computeRecursively call it while ensuring dependency validity.

Compute has access to dependencies as a NodeRefVec (base Node_DF classes only). The recommended usage is to check dependency types at Node construction. Then use static_cast to access derived classes efficiently from the NodeRefVec. See DataFlowNumeric.h for examples.

Implements bpp::Node_DF.

Definition at line 1264 of file DataFlowNumeric.h.

References bpp::failureComputeWasCalled().

◆ computeRecursively()

void bpp::Node_DF::computeRecursively ( )

inherited

Compute this node value, recomputing dependencies (transitively) as needed.

Not thread safe !

Definition at line 183 of file DataFlow.cpp.

References bpp::Node_DF::isValid().

Referenced by bpp::Value< T >::targetValue().

◆ create()

template<typename T >

template<typename ... Args>

static std::shared_ptr<Self> bpp::NumericMutable< T >::create	(	Context &	,
		Args &&...	args
	)

inlinestatic

Build a new NumericMutable node with T(args...) value.

Definition at line 1212 of file DataFlowNumeric.h.

Referenced by bpp::AlignedPhyloLikelihoodMixture::AlignedPhyloLikelihoodMixture(), bpp::ConfiguredParameter::create(), bpp::HmmLikelihood_DF::HmmLikelihood_DF(), bpp::MixtureProcessPhyloLikelihood::MixtureProcessPhyloLikelihood(), bpp::ConfiguredParameter::recreate(), and bpp::LikelihoodCalculationSingleProcess::setNumericalDerivateConfiguration().

◆ debugInfo()

template<typename T >

std::string bpp::NumericMutable< T >::debugInfo ( ) const

inlineoverridevirtual

Node debug info (default = ""): user defined detailed info for DF graph debug.

Reimplemented from bpp::Node_DF.

Definition at line 1235 of file DataFlowNumeric.h.

References bpp::Value< T >::accessValueConst(), and bpp::numeric::debug().

◆ dependencies()

const NodeRefVec& bpp::Node_DF::dependencies ( ) const

inlinenoexceptinherited

Definition at line 183 of file DataFlow.h.

References bpp::Node_DF::dependencyNodes_.

Referenced by bpp::CWiseAdd< R, ReductionOf< T > >::compute(), bpp::CombineDeltaShifted< T >::compute(), bpp::CWiseMul< R, ReductionOf< T > >::compute(), bpp::ConfiguredDistribution::ConfiguredDistribution(), bpp::ConfiguredFrequencySet::ConfiguredFrequencySet(), bpp::ConfiguredModel::ConfiguredModel(), bpp::ConfiguredSimplex::ConfiguredSimplex(), bpp::ConfiguredTransitionMatrix::ConfiguredTransitionMatrix(), bpp::CWiseMul< R, std::tuple< T0, T1 > >::derive(), and bpp::CWiseMul< R, ReductionOf< T > >::derive().

◆ dependency()

const NodeRef& bpp::Node_DF::dependency ( std::size_t i ) const

inlinenoexceptinherited

Definition at line 185 of file DataFlow.h.

References bpp::Node_DF::dependencyNodes_.

◆ dependentNodes()

const std::vector<Node_DF*>& bpp::Node_DF::dependentNodes ( ) const

inlinenoexceptinherited

Definition at line 175 of file DataFlow.h.

References bpp::Node_DF::dependentNodes_.

◆ derive()

template<typename T >

NodeRef bpp::NumericMutable< T >::derive	(	Context &	c,
		const Node_DF &	node
	)

inlinefinalvirtual

Returns a node computing d(this_node_expression)/d(node_expression).

The expression represented by 'node' is considered as a variable. Event if 'node' is a constant value node, d(node)/d(node) == 1. The derivative of a matrix is the matrix of the derivatives. Derivation is undefined by default, and this function will throw an exception. Implementations will usually recursively derive sub-expressions and combine them.

Reimplemented from bpp::Node_DF.

Definition at line 1247 of file DataFlowNumeric.h.

References bpp::Value< T >::accessValueConst(), bpp::ConstantZero< T >::create(), and bpp::ConstantOne< T >::create().

◆ deriveAsValue()

template<typename T >

ValueRef<T> bpp::Value< T >::deriveAsValue	(	Context &	c,
		const Node_DF &	node
	)

inlineinherited

Derive and cast result as Value<T> (most nodes derive to the same value type).

Definition at line 389 of file DataFlow.h.

References bpp::Node_DF::derive().

◆ description()

template<typename T >

std::string bpp::NumericMutable< T >::description ( ) const

inlineoverridevirtual

Node pretty name (default = type name).

Reimplemented from bpp::Node_DF.

Definition at line 1241 of file DataFlowNumeric.h.

References bpp::Value< T >::accessValueConst(), bpp::numeric::debug(), and bpp::Node_DF::description().

◆ hashAdditionalArguments()

std::size_t bpp::Node_DF::hashAdditionalArguments ( ) const

virtualinherited

Return the hash of node-specific configuration.

Compute a hash from additional arguments of the node. The hashed values must the same as the ones compared by compareAdditionalArguments. The default returns 0, which is ok if there are no additional arguments.

Reimplemented in bpp::Sequence_DF, bpp::ConfiguredParameter, bpp::ConfiguredModel, bpp::NumericConstant< T >, bpp::ShiftParameter, bpp::ConstantOne< T >, bpp::ConstantZero< T >, bpp::CombineDeltaShifted< T >, bpp::ShiftDelta< T >, bpp::CWiseConstantPow< T >, bpp::ConfiguredTransitionMatrix, bpp::ConfiguredSimplex, bpp::ConfiguredFrequencySet, and bpp::ConfiguredDistribution.

Definition at line 171 of file DataFlow.cpp.

◆ hasNumericalProperty()

bool bpp::Node_DF::hasNumericalProperty ( NumericalProperty prop ) const

virtualinherited

Test if the node has the given numerical property.

This is an optional indication only, used for optimisations. If unsure, leave it to always false (the default implementation). This should be non recursive, to ensure a constant time check.

Reimplemented in bpp::NumericConstant< T >, bpp::ConstantOne< T >, and bpp::ConstantZero< T >.

Definition at line 168 of file DataFlow.cpp.

Referenced by bpp::ScalarProduct< R, T0, T1 >::create(), bpp::CWisePattern< R >::create(), bpp::CWiseAdd< R, T >::create(), bpp::CWiseMean< R, ReductionOf< T >, ReductionOf >::create(), bpp::CWiseDiv< R, std::tuple< T0, T1 > >::create(), bpp::CWiseNegate< T >::create(), bpp::CWiseInverse< T >::create(), bpp::CWiseLog< T >::create(), bpp::CWiseExp< T >::create(), bpp::CWiseConstantPow< T >::create(), and bpp::CombineDeltaShifted< T >::create().

◆ invalidateRecursively()

void bpp::Node_DF::invalidateRecursively ( )

protectednoexceptinherited

Invalidate (transitively) dependent nodes from this one.

Not thread safe !

Definition at line 219 of file DataFlow.cpp.

References bpp::Node_DF::isValid().

Referenced by bpp::Value< T >::modify(), and bpp::Node_DF::resetDependencies_().

◆ isValid()

bool bpp::Node_DF::isValid ( ) const

inlinenoexceptinherited

Definition at line 166 of file DataFlow.h.

References bpp::Node_DF::isValid_.

Referenced by bpp::Node_DF::computeRecursively(), bpp::Node_DF::invalidateRecursively(), and bpp::writeDotNode().

◆ makeInvalid()

void bpp::Node_DF::makeInvalid ( )

inlineprotectednoexceptinherited

Definition at line 270 of file DataFlow.h.

References bpp::Node_DF::isValid_.

Referenced by bpp::Node_DF::resetDependencies_().

◆ makeValid()

void bpp::Node_DF::makeValid ( )

inlineprotectednoexceptinherited

Definition at line 271 of file DataFlow.h.

References bpp::Node_DF::isValid_.

Referenced by bpp::Value< T >::modify(), bpp::NumericConstant< T >::NumericConstant(), bpp::NumericMutable< T >::NumericMutable(), and bpp::Sequence_DF::Sequence_DF().

◆ modify()

template<typename T >

template<typename Callable >

void bpp::Value< T >::modify	(	Callable &&	modifier,
		bool	makeValid
	)

inlineinherited

General case for modification of the T object.

Takes a callable object (lambda, function pointer) that performs the modification. It must take a single T& as argument, which will refer to the T object to modify. The callable is called exactly once.

Parameters

modifier	callable to modify this object
makeValid	boolean if this object is valid after modification (which means no call to this->compute()

Definition at line 405 of file DataFlow.h.

References bpp::Value< T >::accessValueMutable(), bpp::Node_DF::invalidateRecursively(), and bpp::Node_DF::makeValid().

Referenced by bpp::NumericMutable< T >::setValue().

◆ nbDependencies()

std::size_t bpp::Node_DF::nbDependencies ( ) const

inlinenoexceptinherited

Number of dependencies (ie nodes we depend on)

Definition at line 181 of file DataFlow.h.

References bpp::Node_DF::dependencyNodes_.

◆ nbDependentNodes()

std::size_t bpp::Node_DF::nbDependentNodes ( ) const

inlinenoexceptinherited

Number of dependent nodes (ie nodes that depend on this)

Definition at line 172 of file DataFlow.h.

References bpp::Node_DF::dependentNodes_.

◆ recreate()

template<typename T >

NodeRef bpp::NumericMutable< T >::recreate	(	Context &	c,
		NodeRefVec &&	deps
	)

inlinefinalvirtual

Recreate the node with different dependencies.

Reimplemented from bpp::Node_DF.

Definition at line 1257 of file DataFlowNumeric.h.

References bpp::checkRecreateWithoutDependencies().

◆ registerNode()

void bpp::Node_DF::registerNode ( Node_DF * n )

privateinherited

Definition at line 240 of file DataFlow.cpp.

References bpp::Node_DF::dependentNodes_.

◆ resetDependencies_()

void bpp::Node_DF::resetDependencies_ ( NodeRefVec && dependenciesArg )

inlineprotectedinherited

Definition at line 288 of file DataFlow.h.

References bpp::Node_DF::dependencyNodes_, bpp::Node_DF::invalidateRecursively(), and bpp::Node_DF::makeInvalid().

◆ setValue() [1/2]

template<typename T >

void bpp::NumericMutable< T >::setValue ( const T & t )

inline

Setter with invalidation.

Definition at line 1224 of file DataFlowNumeric.h.

References bpp::Value< T >::modify().

◆ setValue() [2/2]

template<typename T >

void bpp::NumericMutable< T >::setValue ( T && t )

inline

Setter with invalidation (movable value version).

Definition at line 1230 of file DataFlowNumeric.h.

References bpp::Value< T >::modify().

◆ shape()

virtual std::string bpp::Node_DF::shape ( ) const

inlinevirtualinherited

Reimplemented in bpp::MatrixProduct< R, T0, T1 >, bpp::CWiseDiv< R, std::tuple< T0, T1 > >, bpp::CWiseMul< R, std::tuple< T0, T1 > >, bpp::CWiseMean< R, ReductionOf< T >, P >, bpp::CWiseMean< R, ReductionOf< T >, ReductionOf >, bpp::CWiseAdd< R, std::tuple< T0, T1 > >, bpp::CWiseApply< R, T, F >, bpp::TransitionMatrixFromTransitionMatrix, bpp::TransitionFunctionFromModel, and bpp::TransitionMatrixFromModel.

Definition at line 195 of file DataFlow.h.

Referenced by bpp::writeDotNode().

◆ targetValue()

template<typename T >

const T& bpp::Value< T >::targetValue ( )

inlineinherited

Access value, recompute if needed.

Recompute the value if it is not up to date. Then access it as const. Recomputation is single threaded and not thread safe.

Definition at line 374 of file DataFlow.h.

References bpp::Value< T >::accessValueConst(), and bpp::Node_DF::computeRecursively().

◆ unregisterNode()

void bpp::Node_DF::unregisterNode ( const Node_DF * n )

privateinherited

Definition at line 245 of file DataFlow.cpp.

References bpp::Node_DF::dependentNodes_.

Member Data Documentation

◆ dependencyNodes_

NodeRefVec bpp::Node_DF::dependencyNodes_ {}

privateinherited

Definition at line 312 of file DataFlow.h.

Referenced by bpp::Node_DF::dependencies(), bpp::Node_DF::dependency(), bpp::Node_DF::nbDependencies(), bpp::Node_DF::Node_DF(), bpp::Node_DF::resetDependencies_(), and bpp::Node_DF::~Node_DF().

◆ dependentNodes_

std::vector<Node_DF*> bpp::Node_DF::dependentNodes_ {}

privateinherited

Definition at line 313 of file DataFlow.h.

Referenced by bpp::Node_DF::dependentNodes(), bpp::Node_DF::nbDependentNodes(), bpp::Node_DF::registerNode(), and bpp::Node_DF::unregisterNode().

◆ isValid_

bool bpp::Node_DF::isValid_ {false}

privateinherited

Definition at line 314 of file DataFlow.h.

Referenced by bpp::Node_DF::isValid(), bpp::Node_DF::makeInvalid(), and bpp::Node_DF::makeValid().

◆ value_

template<typename T >

T bpp::Value< T >::value_

privateinherited

Definition at line 419 of file DataFlow.h.

Referenced by bpp::Value< T >::accessValueConst(), and bpp::Value< T >::accessValueMutable().

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

Bpp/Phyl/Likelihood/DataFlow/DataFlowNumeric.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename T> class bpp::NumericMutable< T >

Member Typedef Documentation

◆ Self

Constructor & Destructor Documentation

◆ NumericMutable()

Member Function Documentation

◆ accessValueConst()

◆ accessValueMutable()

◆ color()

◆ compareAdditionalArguments()

◆ compute()

◆ computeRecursively()

◆ create()

◆ debugInfo()

◆ dependencies()

◆ dependency()

◆ dependentNodes()

◆ derive()

◆ deriveAsValue()

◆ description()

◆ hashAdditionalArguments()

◆ hasNumericalProperty()

◆ invalidateRecursively()

◆ isValid()

◆ makeInvalid()

◆ makeValid()

◆ modify()

◆ nbDependencies()

◆ nbDependentNodes()

◆ recreate()

◆ registerNode()

◆ resetDependencies_()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ shape()

◆ targetValue()

◆ unregisterNode()

Member Data Documentation

◆ dependencyNodes_

◆ dependentNodes_

◆ isValid_

◆ value_

template<typename T>
class bpp::NumericMutable< T >