Constraints.hpp File Reference

#include "gstlearn_export.hpp"
#include "Enum/EConsElem.hpp"
#include "Enum/EConsType.hpp"
#include "Basic/AStringable.hpp"
#include <vector>

Classes
class	Constraints

Functions
GSTLEARN_EXPORT double	constraints_get (const Constraints &constraints, const EConsType &icase, int igrf, int icov, const EConsElem &icons, int v1, int v2)
GSTLEARN_EXPORT void	constraints_print (const Constraints &constraints)
GSTLEARN_EXPORT int	modify_constraints_on_sill (Constraints &constraints)
GSTLEARN_EXPORT int	add_unit_sill_constraints (Constraints &constraints)

Function Documentation

add_unit_sill_constraints()

GSTLEARN_EXPORT int add_unit_sill_constraints

(

Constraints &

constraints

)

Add constraints (all equal to 1) to the Option_AutoFit structure

Returns

Error return code

Parameters

[in]

constraints

Constraints structure

constraints_get()

GSTLEARN_EXPORT double constraints_get	(	const Constraints &	constraints,
		const EConsType &	icase,
		int	igrf,
		int	icov,
		const EConsElem &	icons,
		int	iv1,
		int	iv2
	)

Return the constraint value (if defined) or TEST

Returns

Returned value or TEST

Parameters

[in,out]	constraints	Constraints structure
[in]	icase	Parameter type (EConsType)
[in]	igrf	Rank of the Gaussian Random Function
[in]	icov	Rank of the structure (starting from 0)
[in]	icons	Type of the constraint (EConsElem)
[in]	iv1	Rank of the first variable
[in]	iv2	Rank of the second variable

constraints_print()

GSTLEARN_EXPORT void constraints_print

(

const Constraints &

constraints

)

Print the Auto Fitting Constraints Structure

Parameters

[in]

constraints

Constraints structure

modify_constraints_on_sill()

GSTLEARN_EXPORT int modify_constraints_on_sill

(

Constraints &

constraints

)

If a constraint concerns a sill, take its square root as it corresponds to a constraints on AIC (not on a sill directly) due to the fact that it will be processed in FOXLEG (not in GOULARD) This transform only makes sense for MONOVARIATE case (the test should have been performed beforehand)

Returns

Error code (if the sill constraint is negative)

Parameters

[in]

constraints

Constraints structure