iode.Variables.__truediv__
- Variables.__truediv__(other)[source]
divide the current (subset of) Variables object by other.
- Parameters:
- other: int, float, numpy ndarray, pandas Series, pandas DataFrame, larray Array or iode Variables
If other is an int or a float, divide all values of the current (subset of) Variables object by the scalar. If other is a numpy ndarray, the shape of the ndarray must be compatible with the current (subset of) Variables object. Specifically, the number of rows must be equal to the number of variables and the number of columns must be equal to the number of periods. If other is a pandas Series, it must represent either a single variable or a single period. If other is a pandas DataFrame, it must represent the same variables names and periods as the current (subset of) Variables object. Specifically, the index of the DataFrame must be equal to the variables names and the columns of the DataFrame must be equal to the periods. If other is an larray Array, its last axis must be equal to the periods and be named ‘time’. If the Array has more than two axes, the first n-1 axes are combined to form the variables names. The first (combined) axis must be equal to the variables names. If other is an iode Variables object, it must share the same sample and represent the same set of variables names as self.
- Returns:
- Variables
Warning
Dividing a numpy ndarray to a Variables object is not recommended as there is no compatibility check between for the names and periods. The result is not guaranteed to be the one you expected. This possibility is provided for speed reasons (when the database or the subset is large).
Examples
>>> import numpy as np >>> import pandas as pd >>> import larray as la >>> from iode import SAMPLE_DATA_DIR >>> from iode import variables, NA, Sample >>> variables.load(f"{SAMPLE_DATA_DIR}/fun.var") Loading .../fun.var 394 objects loaded >>> vars_subset = variables["A*", "1991Y1:1995Y1"] >>> vars_subset.names ['ACAF', 'ACAG', 'AOUC', 'AOUC_', 'AQC'] >>> vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 30.16 34.66 8.16 -13.13 ACAG -30.93 -40.29 -43.16 -16.03 -41.85 AOUC 1.02 1.03 1.03 1.05 1.05 AOUC_ 0.96 0.97 0.98 0.99 1.00 AQC 1.06 1.11 1.15 1.16 1.16
>>> # divide all values of a subset of a Variables object by a scalar >>> new_vars_subset = vars_subset / 2.0 >>> new_vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 13.12 15.08 17.33 4.08 -6.57 ACAG -15.47 -20.14 -21.58 -8.01 -20.92 AOUC 0.51 0.52 0.52 0.52 0.52 AOUC_ 0.48 0.49 0.49 0.49 0.50 AQC 0.53 0.56 0.58 0.58 0.58
>>> # divide (a subset of) a Variables object by another >>> new_vars_subset = vars_subset / vars_subset >>> new_vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 1.00 1.00 1.00 1.00 1.00 ACAG 1.00 1.00 1.00 1.00 1.00 AOUC 1.00 1.00 1.00 1.00 1.00 AOUC_ 1.00 1.00 1.00 1.00 1.00 AQC 1.00 1.00 1.00 1.00 1.00
>>> # divide a a single variable by a pandas Series >>> series = pd.Series([1.0, 2.0, 3.0, 4.0, 5.0], index=vars_subset.periods_as_str) >>> series 1991Y1 1.0 1992Y1 2.0 1993Y1 3.0 1994Y1 4.0 1995Y1 5.0 dtype: float64 >>> updated_ACAF = vars_subset["ACAF"] / series >>> updated_ACAF Workspace: Variables nb variables: 1 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 15.08 11.55 2.04 -2.63
>>> # divide a pandas Series to the subset corresponding to a single period >>> series = pd.Series([1.0, 2.0, 3.0, 4.0, 5.0], index=vars_subset.names) >>> series ACAF 1.0 ACAG 2.0 AOUC 3.0 AOUC_ 4.0 AQC 5.0 dtype: float64 >>> vars_subset_1995Y1 = vars_subset[:, "1995Y1"] / series >>> vars_subset_1995Y1 Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1995Y1:1995Y1 mode: LEVEL name 1995Y1 ACAF -13.13 ACAG -20.92 AOUC 0.35 AOUC_ 0.25 AQC 0.23
>>> # divide a (subset of a) Variables object by a pandas DataFrame >>> data = np.array([[1.0, 2.0, 3.0, 4.0, 5.0], ... [6.0, 7.0, 8.0, 9.0, 10.0], ... [11.0, 12.0, 13.0, 14.0, 15.0], ... [16.0, 17.0, 18.0, 19.0, 20.0], ... [21.0, 22.0, 23.0, 24.0, 25.0]],) >>> df = pd.DataFrame(data, index=vars_subset.names, columns=vars_subset.periods_as_str) >>> df 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 1.0 2.0 3.0 4.0 5.0 ACAG 6.0 7.0 8.0 9.0 10.0 AOUC 11.0 12.0 13.0 14.0 15.0 AOUC_ 16.0 17.0 18.0 19.0 20.0 AQC 21.0 22.0 23.0 24.0 25.0 >>> new_vars_subset = vars_subset / df >>> new_vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 15.08 11.55 2.04 -2.63 ACAG -5.16 -5.76 -5.39 -1.78 -4.18 AOUC 0.09 0.09 0.08 0.07 0.07 AOUC_ 0.06 0.06 0.05 0.05 0.05 AQC 0.05 0.05 0.05 0.05 0.05
>>> # divide (a subset of) a Variables object by an larray Array >>> axis_names = la.Axis(name="names", labels=vars_subset.names) >>> axis_time = la.Axis(name="time", labels=vars_subset.periods_as_str) >>> array = la.Array(data, axes=(axis_names, axis_time)) >>> array names\time 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 1.0 2.0 3.0 4.0 5.0 ACAG 6.0 7.0 8.0 9.0 10.0 AOUC 11.0 12.0 13.0 14.0 15.0 AOUC_ 16.0 17.0 18.0 19.0 20.0 AQC 21.0 22.0 23.0 24.0 25.0 >>> new_vars_subset = vars_subset / array >>> new_vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 15.08 11.55 2.04 -2.63 ACAG -5.16 -5.76 -5.39 -1.78 -4.18 AOUC 0.09 0.09 0.08 0.07 0.07 AOUC_ 0.06 0.06 0.05 0.05 0.05 AQC 0.05 0.05 0.05 0.05 0.05
>>> # WARNING: dividing a numpy ndarray to a (subset of a) Variables object is not recommended >>> # as there is no compatibility check between for the names and periods. >>> # The result is not guaranteed to be the one you expected. >>> # This possibility is provided for speed reasons >>> # (when dealing with large subsets/databases). >>> # divide a single variable by a numpy 1D ndarray >>> data = np.array([1.0, 2.0, 3.0, 4.0, 5.0]) >>> updated_ACAF = vars_subset["ACAF"] / data >>> updated_ACAF Workspace: Variables nb variables: 1 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 15.08 11.55 2.04 -2.63 >>> # divide the subset corresponding to a single period by a numpy 1D ndarray >>> vars_subset_1995Y1 = vars_subset[:, "1995Y1"] / data >>> vars_subset_1995Y1 Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1995Y1:1995Y1 mode: LEVEL name 1995Y1 ACAF -13.13 ACAG -20.92 AOUC 0.35 AOUC_ 0.25 AQC 0.23 >>> # divide a (subset of a) Variables object by a numpy 2D ndarray >>> data = np.array([[1.0, 2.0, 3.0, 4.0, 5.0], ... [6.0, 7.0, 8.0, 9.0, 10.0], ... [11.0, 12.0, 13.0, 14.0, 15.0], ... [16.0, 17.0, 18.0, 19.0, 20.0], ... [21.0, 22.0, 23.0, 24.0, 25.0]]) >>> new_vars_subset = vars_subset / data >>> new_vars_subset Workspace: Variables nb variables: 5 filename: ...fun.var description: Modèle fun - Simulation 1 sample: 1991Y1:1995Y1 mode: LEVEL name 1991Y1 1992Y1 1993Y1 1994Y1 1995Y1 ACAF 26.24 15.08 11.55 2.04 -2.63 ACAG -5.16 -5.76 -5.39 -1.78 -4.18 AOUC 0.09 0.09 0.08 0.07 0.07 AOUC_ 0.06 0.06 0.05 0.05 0.05 AQC 0.05 0.05 0.05 0.05 0.05