Compute results
ComputeResultsMixin
¶
get_result
staticmethod
¶
get_result(key)
Retrieves the variable result that is stored within the calculation report object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
The string that matches the parameter name. |
required |
Returns:
| Type | Description |
|---|---|
|
Str | Numeric | pd.DataFrame: Provides the result of the argument requested, either as a |
|
|
primitive numerical, string or table-like (DataFrame) object. |
Examples:
1 | |
get_result_history
staticmethod
¶
get_result_history(key)
Retrieves the result history for the associated key that is stored within the calculation report object.
Note: Only available for calculation objects (i.e. those from calc)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
The string that matches the parameter name. |
required |
Returns:
| Type | Description |
|---|---|
|
List[NumericValueT]: Provides the list of results for the requested variable. |
Examples:
1 | |