gstlrn::OptimCostColored Class Reference

#include <OptimCostColored.hpp>

Inheritance diagram for gstlrn::OptimCostColored:

Public Member Functions
	OptimCostColored ()
	OptimCostColored (Id nprop, PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const 1 &propseis=1(), const 1 &varseis=1())
	OptimCostColored (const OptimCostColored &m)
OptimCostColored &	operator= (const OptimCostColored &m)
virtual	~OptimCostColored ()
void	reset (Id nprop, PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const 1 &propseis=1(), const 1 &varseis=1())
	minimize (const 1 &facies, const 1 &splits=1(), const 1 &meanprops=1(), bool verbose=false, Id maxiter=100, double eps=5.e-4)
	initSplit (Id nfacies, bool verbose=false) const
void	printSplits (const 1 &splits=1()) const
void	setMeanProps (const 1 &meanProps)
void	setSplits (const 1 &splits)
Public Member Functions inherited from gstlrn::OptimCostBinary
	OptimCostBinary ()
	OptimCostBinary (const OptimCostBinary &m)
OptimCostBinary &	operator= (const OptimCostBinary &m)
virtual	~OptimCostBinary ()
void	reset (PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const 1 &propseis=1(), const 1 &varseis=1())
	minimize (1 &indic, bool verbose=false, Id maxiter=100, double eps=5.e-4)
void	calculateGradient (const 1 &indic, const 1 &lambda, double *out)
Id	setMeanProportion (double meanprop)
Id	isInitialized () const
Id	getNPoint () const
Id	getNVertex () const
void	toggleSeismic (bool status)
Public Member Functions inherited from gstlrn::IOptimCost
	IOptimCost ()
virtual	~IOptimCost ()

Additional Inherited Members
Static Public Member Functions inherited from gstlrn::OptimCostBinary
static void	setPreCondParams (Id chebncmax=10001, double chebtol=5.e-3)

Constructor & Destructor Documentation

OptimCostColored() [1/3]

gstlrn::OptimCostColored::OptimCostColored

(

)

OptimCostColored() [2/3]

gstlrn::OptimCostColored::OptimCostColored	(	Id	nprop,
		PrecisionOp *	pmat,
		const ProjMatrix *	projdata,
		const ProjMatrix *	projseis = nullptr,
		const 1 &	propseis = 1(),
		const 1 &	varseis = 1()
	)

OptimCostColored() [3/3]

gstlrn::OptimCostColored::OptimCostColored

(

const OptimCostColored &

m

)

~OptimCostColored()

gstlrn::OptimCostColored::~OptimCostColored ( )

virtual

Member Function Documentation

initSplit()

gstlrn::OptimCostColored::initSplit	(	Id	nfacies,
		bool	verbose = false
	)		const

Provides the list of regrouped facies during Optimizaition

Parameters

nfacies	Number of facies
verbose	Verbose flag

Returns

For each level, Vector of regrouped facies

minimize()

gstlrn::OptimCostColored::minimize	(	const 1 &	facies,
		const 1 &	splits = 1(),
		const 1 &	meanprops = 1(),
		bool	verbose = false,
		Id	maxiter = 100,
		double	eps = 5.e-4
	)

Perform the minimization

Returns

Array of facies proportions (Dimension: [nprop][nvertex]

Parameters

[in]	facies	Array containing the Facies values (see remarks) (Dimension: npoint)
[in]	splits	Array giving the facies split (Dimension: [nfacies-1][nfacies])
[in]	meanprops	Array of mean of proportions (Dimension: nfacies)
[in]	verbose	Verbose flag
[in]	maxiter	Maximum number of iterations for Optimization algorithm
[in]	eps	Tolerance for Optimization algorithm

Remarks

Argument 'facies' should contain values ranging from 1 to _nprop

operator=()

OptimCostColored & gstlrn::OptimCostColored::operator=

(

const OptimCostColored &

m

)

printSplits()

void gstlrn::OptimCostColored::printSplits

(

const 1 &

splits = 1()

)

const

Internal function to print the Splits

reset()

void gstlrn::OptimCostColored::reset	(	Id	nprop,
		PrecisionOp *	pmat,
		const ProjMatrix *	projdata,
		const ProjMatrix *	projseis = nullptr,
		const 1 &	propseis = 1(),
		const 1 &	varseis = 1()
	)

Initialize the Hessian Operator

Parameters

[in]	nprop	Number of different proportions (or facies)
[in]	pmat	The precision matrix to be optimized
[in]	projdata	The Projection operator between Data and Meshing
[in]	projseis	The Projection operator between Seismic and Meshing
[in]	propseis	Array of facies proportions
[in]	varseis	Array of variance attached to the seismic

setMeanProps()

void gstlrn::OptimCostColored::setMeanProps ( const 1 &  meanProps )

inline

setSplits()

void gstlrn::OptimCostColored::setSplits ( const 1 &  splits )

inline

---

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

• include/LinearOp/OptimCostColored.hpp
• src/LinearOp/OptimCostColored.cpp