Functions

get_const_parameter_names

get_const_parameter_names( (PyParameterManager)parameter_manager, (bool)exclude_dependent) -> WStrList

get_dependent_parameter_names

get_dependent_parameter_names( (PyParameterManager)parameter_manager) -> WStrList

get_lower_bound_values

get_lower_bound_values( (PyParameterManager)parameter_manager) -> PyOSDesignPoint

get_non_const_det_props

get_non_const_det_props( (PyParameterManager)parameter_manager) -> DPropList

get_non_const_parameter_names

get_non_const_parameter_names( (PyParameterManager)parameter_manager, (bool)exclude_dependent) -> WStrList

get_non_const_ran_props

get_non_const_ran_props( (PyParameterManager)parameter_manager) -> ParameterList

get_num_non_const_det_props

get_num_non_const_det_props( (PyParameterManager)parameter_manager) -> int

get_num_non_const_ran_props

get_num_non_const_ran_props( (PyParameterManager)parameter_manager) -> int

get_parameter_names

get_parameter_names( (PyParameterManager)parameter_manager) -> WStrList

get_pure_deterministic_parameter_names

get_pure_deterministic_parameter_names( (PyParameterManager)parameter_manager) -> WStrList

get_pure_stochastic_parameter_names

get_pure_stochastic_parameter_names( (PyParameterManager)parameter_manager) -> WStrList

get_upper_bound_values

get_upper_bound_values( (PyParameterManager)parameter_manager) -> PyOSDesignPoint

GetConstParameterNames

deprecated

GetDependentParameterNames

deprecated

GetLowerBoundValues

deprecated

GetNonConstDetProps

deprecated

GetNonConstParameterNames

deprecated

getNumNonConstDetProps

deprecated

GetParameterNames

deprecated

GetUpperBoundValues

deprecated

Classes

DProp

Constructors

DProp()

DPropList

iterable

Constructors

DPropList()

Methods

dprop_export_list

dprop_export_list() -> DPropList

DPropExportList deprecated

push_back

push_back( (DPropPair)arg2) -> None

size

size() -> int

DPropPair

Constructors

DPropPair()

Properties

(str) first
(DProp) second

ParameterList

iterable

Constructors

ParameterList()

Methods

param_export_list

param_export_list() -> ParameterList

ParamExportList deprecated

push_back

push_back( (PyParameter)arg2) -> None

size

size() -> int

PyParameter

Constructors

PyParameter()
PyParameter( (str) )
PyParameter( (str) , (float) , (float) , (float) , (int) )
PyParameter( (str) , (float) , (float) , (PyOSDesignEntry) , (int) )
PyParameter( (str) , (PyOSDesignEntryVec) , (DeterministicType) )
PyParameter( (str) , (str) )
PyParameter( (str) , (RandomVariableType) , (RandomVariableKind) , (PyOSDesignEntry) )

Methods

erase_det_prop

erase_det_prop( (str)name) -> None

EraseDetProp deprecated

get_dependency_expression

get_dependency_expression() -> str

get_det_discrete_states

get_det_discrete_states( (PyParameter)name) -> PyOSDesignEntryVec

get_det_kind

get_det_kind() -> DeterministicType

get_det_prop_by_index

get_det_prop_by_index( (int)index) -> DProp

get_det_prop_name

get_det_prop_name( (int)index) -> object

get_det_props

get_det_props() -> DPropList

get_det_type

get_det_type() -> EntryType

get_id

get_id() -> id.html#UUID" class="pythontype">UUID

get_lower_bound

get_lower_bound() -> PyOSDesignEntry

get_mutable_map

get_mutable_map() -> object

get_name

get_name() -> str

get_parameter_type

get_parameter_type() -> ParameterType

get_ran_cov

get_ran_cov() -> float

get_ran_kind

get_ran_kind() -> RandomVariableKind

get_ran_parameters

get_ran_parameters() -> doubleVec

get_ran_prop

get_ran_prop() -> RanProp

get_ran_statistical_moments

get_ran_statistical_moments() -> doubleVec

get_ran_type

get_ran_type() -> RandomVariableType

get_reference_value

get_reference_value() -> PyOSDesignEntry

get_upper_bound

get_upper_bound() -> PyOSDesignEntry

GetDependencyExpression deprecated

GetDetDiscreteStates deprecated

GetDetKind deprecated

GetDetPropByIndex deprecated

GetDetPropName deprecated

GetDetProps deprecated

GetDetType deprecated

GetId deprecated

GetLowerBound deprecated

GetMutableMap deprecated

GetName deprecated

GetParameterType deprecated

GetRanCOV deprecated

GetRanKind deprecated

GetRanParameters deprecated

GetRanProp deprecated

GetRanStatisticalMoments deprecated

GetRanType deprecated

GetReferenceValue deprecated

GetUpperBound deprecated

has_continuous_distribution

has_continuous_distribution() -> bool

has_marginal_distribution

has_marginal_distribution() -> bool

has_set_ran_cov

has_set_ran_cov() -> bool

has_set_ran_parameters

has_set_ran_parameters() -> bool

has_set_ran_statistical_moments

has_set_ran_statistical_moments() -> bool

HasContinuousDistribution deprecated

HasMarginalDistribution deprecated

HasSetRanCOV deprecated

HasSetRanParameters deprecated

HasSetRanStatisticalMoments deprecated

is_active

is_active() -> bool

is_const

is_const() -> bool

is_continuous

is_continuous() -> bool

is_dependent

is_dependent() -> bool

is_empirical

is_empirical() -> bool

is_mixed

is_mixed() -> bool

is_modifiable

is_modifiable() -> bool

is_mutable

is_mutable( (object)member) -> bool

is_optimization

is_optimization() -> bool

is_pure_optimization

is_pure_optimization() -> bool

is_pure_stochastic

is_pure_stochastic() -> bool

is_ran_prop_validated

is_ran_prop_validated() -> bool

is_stochastic

is_stochastic() -> bool

IsActive deprecated

IsConst deprecated

IsContinuous deprecated

IsDependent deprecated

IsEmpirical deprecated

IsMixed deprecated

IsModifiable deprecated

IsMutable deprecated

IsOptimization deprecated

IsPureOptimization deprecated

IsPureStochastic deprecated

IsRanPropValidated deprecated

IsStochastic deprecated

rename_det_prop

rename_det_prop( (str)arg2) -> None

----

rename_det_prop( (str)arg2, (str)to) -> None

rename_parameter

rename_parameter( (str)to) -> None

RenameDetProp deprecated

RenameParameter deprecated

set_active

set_active( (bool)active) -> None

set_bounds

set_bounds( (PyOSDesignEntry)lower_bound, (PyOSDesignEntry)upper_bound [, (bool)unsafe=False]) -> None

set_const

set_const( (bool)constant) -> None

set_dependent

set_dependent( (str)expression) -> None

set_det_prop_by_index

set_det_prop_by_index( (DProp)value, (int)index) -> None

set_discrete_states

set_discrete_states( (PyOSDesignEntryVec)states [, (bool)unsafe=False]) -> None

set_kind

set_kind( (DeterministicType)kind) -> None

set_lower_bound

set_lower_bound( (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

set_modifiable

set_modifiable( (bool)arg2) -> None

set_mutable

set_mutable( (object)member, (bool)state) -> None

set_mutable_map

set_mutable_map( (object)arg2) -> None

set_parameter_type

set_parameter_type( (ParameterType)type) -> None

set_ran_cov

set_ran_cov( (float)cov) -> float

set_ran_kind

set_ran_kind( (RandomVariableKind)kind) -> None

set_ran_parameters

set_ran_parameters( (doubleVec)parameters) -> None

set_ran_prop_validated

set_ran_prop_validated( (bool)arg2) -> None

set_ran_statistical_moments

set_ran_statistical_moments( (doubleVec)moments) -> None

set_ran_type

set_ran_type( (RandomVariableType)type) -> None

set_reference_value

set_reference_value( (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

set_type

set_type( (EntryType)type) -> None

set_upper_bound

set_upper_bound( (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

SetActive deprecated

SetBounds deprecated

SetConst deprecated

SetDependent deprecated

SetDetPropByIndex deprecated

SetDiscreteStates deprecated

SetKind deprecated

SetLowerBound deprecated

SetModifiable deprecated

SetMutable deprecated

SetMutableMap deprecated

SetParameterType deprecated

SetRanCOV deprecated

SetRanKind deprecated

SetRanParameters deprecated

SetRanPropValidated deprecated

SetRanStatisticalMoments deprecated

SetRanType deprecated

SetReferenceValue deprecated

SetType deprecated

SetUpperBound deprecated

PyParameterManager

iterable has_length

Constructors

PyParameterManager()

Methods

add_dependent_parameter

add_dependent_parameter( (str)parameter_name, (str)expression) -> None

add_deterministic_continuous_parameter

add_deterministic_continuous_parameter( (str)name, (float)lower_bound, (float)upper_bound, (float)reference_value [, (int)range_mode=0]) -> None

Add a new deterministic continuous parameter. A range_mode of 1 or 2 sets a relative lower respectively upper bound. A range_mode of 3 sets both bounds relative.

pm = PyParameterManager()
pm.add_deterministic_continuous_parameter('a', 0., 3., 1.5)

add_parameter

add_parameter( (str)name) -> None

add_stochastic_parameter

add_stochastic_parameter( (str)name, (RandomVariableType)type, (RandomVariableKind)kind, (PyOSDesignEntry)reference_value) -> None

Add a new stochastic parameter. It is required to set a parameter type and random parameters afterwards.

pm = PyParameterManager()
pm.add_stochastic_parameter('s1', RandomVariableType.NORMAL,
                            RandomVariableKind.DETERMINISTIC, PyOSDesignEntry(0.72))
pm.set_parameter_type('s1', ParameterType.STOCHASTIC)
pm.set_ran_parameters('s1', double_list_to_vec(
    [0.72, 0.3]))   # normal distribution: mu, sigmah

AddDependentParameter deprecated

AddDeterministicContinuousParameter deprecated

AddParameter deprecated

AddStochasticParameter deprecated

clear

clear() -> None

contains_parameter

contains_parameter( (str)name) -> bool

----

contains_parameter( (id.html#UUID" class="pythontype">UUID)id) -> bool

ContainsParameter deprecated

empty

empty() -> bool

erase_correlation

erase_correlation( (str)arg2, (str)parameter_name) -> bool

erase_correlations

erase_correlations( (PyParameterManager)parameter_name_a, (str)parameter_name_b) -> bool

erase_parameter

erase_parameter( (str)parameter_name) -> None

EraseCorrelation deprecated

EraseCorrelations deprecated

EraseParameter deprecated

get_bounds

get_bounds( (str)parameter_name, (PyOSDesignEntry)lower_bound, (PyOSDesignEntry)upper_bound) -> None

Note, that lower_bound and upper_bound are output arguments.

----

get_bounds( (str)parameter_name) -> tuple

Return a parameter's boundaries as a tuple.

get_det_props

get_det_props() -> DPropList

get_det_props_by_index

get_det_props_by_index( (str)parameter_name, (int)index) -> DProp

get_parameter

get_parameter( (str)parameter_name) -> PyParameter

----

get_parameter( (id.html#UUID" class="pythontype">UUID)parameter_id) -> PyParameter

get_parameter_by_index

get_parameter_by_index( (int)index) -> PyParameter

get_parameters

get_parameters() -> ParameterList

get_ran_prop

get_ran_prop( (str)parameter_name) -> RanProp

get_ran_props

get_ran_props() -> RanPropList

get_reference_design

get_reference_design() -> PyOSDesignEntryVec

get_reference_design_point

get_reference_design_point() -> PyOSDesignPoint

get_size

get_size() -> int

get_unique_name

get_unique_name() -> str

GetBounds deprecated

GetDetPropByIndex deprecated

GetDetProps deprecated

GetParameter deprecated

GetParameterByIndex deprecated

GetParameters deprecated

GetRanProp deprecated

GetRanProps deprecated

GetReferenceDesign deprecated

GetReferenceDesignPoint deprecated

GetSize deprecated

GetUniqueName deprecated

import_from_csv

import_from_csv( (Path)csv path [, (str)separator]) -> None

Add parameters from csv to parameter manager.

import_from_json

import_from_json( (Path)path) -> None

Add parameters from json to parameter manager.

import_from_json_string

import_from_json_string( (str)content) -> None

Add parameters from json string to parameter manager.

insert_parameter

insert_parameter( (PyParameter)parameter) -> None

InsertParameter deprecated

rename_det_prop

rename_det_prop( (str)parameter_name, (str)from, (str)to) -> None

rename_parameter

rename_parameter( (str)from, (str)to) -> None

RenameDetProp deprecated

RenameParameter deprecated

reset_correlations

reset_correlations() -> None

ResetCorrelations deprecated

save_to_csv

save_to_csv( (Path)csv path [, (str)separator]) -> None

Save parameter manager to a csv file.

save_to_json

save_to_json( (Path)path) -> None

Save parameter manager to a json file.

set_active

set_active( (str)parameter_name, (bool)active) -> None

set_bounds

set_bounds( (str)parameter_name, (PyOSDesignEntry)lower_bound, (PyOSDesignEntry)upper_bound [, (bool)unsafe=False]) -> None

set_const_flag

set_const_flag( (str)parameter_name [, (bool)constant=True]) -> None

set_correlation

set_correlation( (str)parameter_name_a, (str)parameter_name_b, (float)value) -> bool

set_dependent

set_dependent( (str)parameter_name, (str)expression) -> None

set_discrete_states

set_discrete_states( (str)parameter_name, (PyOSDesignEntryVec)discrete_states) -> None

set_kind

set_kind( (str)parameter_name, (DeterministicType)kind) -> None

set_lower_bound

set_lower_bound( (str)parameter_name, (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

set_modifiable

set_modifiable( (str)parameter_name, (bool)modifiable) -> None

set_parameter_type

set_parameter_type( (str)parameter_name, (ParameterType)type) -> None

set_ran_cov

set_ran_cov( (str)parameter_name, (float)cov) -> float

set_ran_kind

set_ran_kind( (str)parameter_name, (RandomVariableKind)kind) -> None

set_ran_parameters

set_ran_parameters( (str)parameter_name, (doubleVec)parameters) -> None

set_ran_statistical_moments

set_ran_statistical_moments( (str)parameter_name, (doubleVec)moments) -> None

set_ran_type

set_ran_type( (str)parameter_name, (RandomVariableType)type) -> None

set_reference_design_point

set_reference_design_point( (PyOSDesignPoint)design_point) -> None

set_reference_value

set_reference_value( (str)parameter_name, (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

set_type

set_type( (str)parameter_name, (EntryType)type) -> None

set_upper_bound

set_upper_bound( (str)parameter_name, (PyOSDesignEntry)value [, (bool)unsafe=False]) -> None

SetActive deprecated

SetBounds deprecated

SetConstFlag deprecated

SetCorrelation deprecated

SetDependent deprecated

SetDiscreteStates deprecated

SetKind deprecated

SetLowerBound deprecated

SetModifiable deprecated

SetParameterType deprecated

SetRanCOV deprecated

SetRanKind deprecated

SetRanParameters deprecated

SetRanStatisticalMoments deprecated

SetRanType deprecated

SetReferenceDesignPoint deprecated

SetReferenceValue deprecated

SetType deprecated

SetUpperBound deprecated

RanProp

Constructors

RanProp()

RanPropList

iterable

Constructors

RanPropList()

Methods

push_back

push_back( (RanPropPair)arg2) -> None

ran_prop_export_list

ran_prop_export_list() -> RanPropList

RanPropExportList deprecated

size

size() -> int

RanPropPair

Constructors

RanPropPair()

Properties

(str) first
(RanProp) second