import sys
from copy import copy
from typing import Union, Tuple, List, Any
if sys.version_info.minor >= 11:
from typing import Self
else:
Self = Any
from iode.iode_cython import Identity as CythonIdentity
[docs]
class Identity:
r"""
An *identity* is an expression written in the *LEC* language that allows the construction of a
new statistical series based on already defined series. In general, *identities* are executed
in groups to create or update a set of *variables*. *Identities* can be executed for a specific
range of periods, or for all periods defined in the workspace.
*Identities* should not be confused with *equations*. They are not part of a model.
Parameters
----------
lec: str
formula (*LEC* expression) used to construct a series.
Examples
--------
>>> from iode import Identity
>>> idt = Identity("FLG/VBBP")
>>> idt
Identity('FLG/VBBP')
"""
[docs]
def __init__(self, lec: str) -> Self:
self._cy_identity = CythonIdentity(lec)
@classmethod
def from_cython_obj(cls, obj: CythonIdentity) -> Self:
instance = cls.__new__(cls)
instance._cy_identity = obj
return instance
@property
def lec(self) -> str:
r"""
Return the *LEC* formula of the identity.
Returns
-------
str
Examples
--------
>>> from iode import Identity
>>> idt = Identity("FLG/VBBP")
>>> idt
Identity('FLG/VBBP')
>>> idt.lec
'FLG/VBBP'
>>> idt.lec = "1"
>>> idt
Identity('1')
>>> idt.lec
'1'
"""
return self._cy_identity.get_lec()
@lec.setter
def lec(self, value: str):
self._cy_identity.set_lec(value)
@property
def coefficients(self) -> List[str]:
r"""
Return the list of coefficients present in the current identity.
Returns
-------
list(str)
Examples
--------
>>> from iode import SAMPLE_DATA_DIR
>>> from iode import Identity, scalars, variables
>>> scalars.load(f"{SAMPLE_DATA_DIR}/fun.scl") # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
Loading .../fun.scl
161 objects loaded
>>> variables.load(f"{SAMPLE_DATA_DIR}/fun.var") # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
Loading .../fun.var
394 objects loaded
>>> idt = Identity("1 - exp((gamma2 + gamma3 * ln(W/ZJ)[-1] + gamma4 * ln(WMIN/ZJ)) / gamma_)")
>>> idt
Identity('1 - exp((gamma2 + gamma3 * ln(W/ZJ)[-1] + gamma4 * ln(WMIN/ZJ)) / gamma_)')
>>> idt.coefficients
['gamma2', 'gamma3', 'gamma4', 'gamma_']
"""
return self._cy_identity.get_coefficients()
@property
def variables(self) -> List[str]:
r"""
Return the list of variables present in the identity.
Returns
-------
list(str)
Examples
--------
>>> from iode import SAMPLE_DATA_DIR
>>> from iode import Identity, scalars, variables
>>> scalars.load(f"{SAMPLE_DATA_DIR}/fun.scl") # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
Loading .../fun.scl
161 objects loaded
>>> variables.load(f"{SAMPLE_DATA_DIR}/fun.var") # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
Loading .../fun.var
394 objects loaded
>>> idt = Identity("1 - exp((gamma2 + gamma3 * ln(W/ZJ)[-1] + gamma4 * ln(WMIN/ZJ)) / gamma_)")
>>> idt
Identity('1 - exp((gamma2 + gamma3 * ln(W/ZJ)[-1] + gamma4 * ln(WMIN/ZJ)) / gamma_)')
>>> idt.variables
['W', 'ZJ', 'WMIN']
"""
return self._cy_identity.get_variables()
[docs]
def copy(self) -> Self:
r"""
Return a copy of the current Identity.
Examples
--------
>>> from iode import Identity
>>> idt = Identity("FLG/VBBP")
>>> idt
Identity('FLG/VBBP')
>>> copied_idt = idt.copy()
>>> copied_idt
Identity('FLG/VBBP')
"""
return copy(self)
def __eq__(self, other: Self) -> bool:
return self._cy_identity.equal(other._cy_identity)
def __copy__(self) -> Self:
r"""
Return a copy of the current Identity.
Examples
--------
>>> from copy import copy
>>> from iode import Identity
>>> idt = Identity("FLG/VBBP")
>>> idt
Identity('FLG/VBBP')
>>> copied_idt = copy(idt)
>>> copied_idt
Identity('FLG/VBBP')
"""
return Identity(str(self))
def __str__(self) -> str:
return self._cy_identity._str_()
def __repr__(self) -> str:
return f"Identity('{str(self)}')"
def __hash__(self) -> int:
return hash(str(self))