/usr/include/openturns/swig/ResourceMap_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | %feature("docstring") OT::ResourceMap
"The ResourceMap allows to manage constants that are associated to key strings.
Find below the ResourceMap's content:
.. execforresourcemap::
Examples
--------
Get some keys:
>>> import openturns as ot
>>> for key in ot.ResourceMap.GetKeys()[:4]:
... print(key)
ARMALikelihoodFactory-DefaultMaxFun
ARMALikelihoodFactory-DefaultRhoBeg
ARMALikelihoodFactory-DefaultRhoEnd
ARMALikelihoodFactory-DefaultStartingPointScale"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::Get
"Access a parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
Returns
-------
value : str
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.Get('DiscreteDistribution-SupportEpsilon')
'1.0e-14'"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::Set
"Access a parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
value : str
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.Set('DiscreteDistribution-SupportEpsilon', '1.0e-14')"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::GetAsBool
"Access a boolean parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
Returns
-------
value : bool
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.GetAsBool('MaximumEntropyOrderStatisticsDistribution-CheckMarginals')
True"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::SetAsBool
"Access a boolean parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
value : bool
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.SetAsBool('MaximumEntropyOrderStatisticsDistribution-CheckMarginals', True)"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::SetAsNumericalScalar
"Access a floating-point parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
value : float
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.SetAsNumericalScalar('SQP-DefaultTau', 0.5)"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::GetAsNumericalScalar
"Access a floating-point parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
Returns
-------
value : float
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.GetAsNumericalScalar('SQP-DefaultTau')
0.5"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::SetAsUnsignedInteger
"Access an integer parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
value : int
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.SetAsUnsignedInteger('MCMC-DefaultBurnIn', 0)"
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::GetAsUnsignedInteger
"Access an integer parameter.
Parameters
----------
key : str
An identifier associated to the parameter.
Returns
-------
value : float
The value associated to that key.
Examples
--------
>>> import openturns as ot
>>> ot.ResourceMap.GetAsUnsignedInteger('MCMC-DefaultBurnIn')
0..."
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::GetSize
"Get the size of the ResourceMap.
Returns
-------
size : positive int
The number of constants defined in the ResourceMap."
// ---------------------------------------------------------------------
%feature("docstring") OT::ResourceMap::GetKeys
"Get the keys of the ResourceMap.
Returns
-------
keys : tuple of str
The list of identifiers."
|