Skip to content

Commit d7d963f

Browse files
committed
Reorder list, copyedit text in doc/notation
1 parent cbeb1ee commit d7d963f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/notation.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ This page explains the notation used in this mathematical formulation section of
2525
= \\&
2626
\text{COMMODITY_BALANCE}_{c h l n y}
2727
28-
- The first line gives:
28+
- The equality (=) or inequality (< or >) relation is on a line by itself.
29+
This allows to distinguish the **left- and right-hand sides** of the expression.
30+
- The first line begins with the "for all …" symbol (:math:`\forall`) and gives:
2931

3032
- The **dimensionality** of the equation or inequality, via a list of **indices** (in alphabetical order).
31-
In some cases, this is equivalent to the dimensionality of a single term on either side; for instance, in the example above, of COMMODITY_BALANCE.
33+
In some cases, this is equivalent to the dimensionality of a single term on either side.
34+
In the example above, this is COMMODITY_BALANCE.
3235
Where both sides are more complicated, the first line informs about the dimensionality.
3336
- Any **conditions or restrictions** on the set members to which the indices apply.
3437
Implicitly, indices without condition may take any value from their corresponding set.
3538
In the example above:
3639

3740
- Index :math:`l` must be in the union of certain other sets.
3841
- The indices :math:`y` (for parameters/variables with a dimension named "year") must always align with indices :math:`y^A` (for parameters/variables with a dimension named "year_active").
39-
- Likewise, :math:`n`, :math:`n^D` (node_dest), and :math:`n_O` (node_origin) must all be aligned
40-
- The other indices are unconstrained, so implicitly :math:`c \in C` and :math:`h in H`.
41-
42-
- The equality (=) or inequality (< or >) is on a line by itself.
43-
This allows to distinguish the **left- and right-hand sides** of the expression.
42+
- Likewise, :math:`n`, :math:`n^D` (node_dest), and :math:`n^O` (node_origin) must all be aligned
43+
- The other indices are unconstrained, so implicitly :math:`c \in C` and :math:`h \in H`.
4444

4545
- References to items (exogenous **parameters** or endogenous **variables**) include:
4646

@@ -52,8 +52,8 @@ This page explains the notation used in this mathematical formulation section of
5252
These:
5353

5454
- Always exactly restate the dimensionality of the item given elsewhere in this documentation.
55-
That is, it does not express aggregation or other operations.
56-
- *May* express an alignment or restriction of indices, if this is particular to one reference of the parameter/variable.
55+
That is, the indices do indicate aggregation or other operations.
56+
- *May* express an alignment or restriction of indices, *if and only if* this is particular to one reference of the parameter/variable.
5757
Otherwise, these are expressed in the first line, as described above.
5858
In the above example, 'duration_time_rel' has indices :math:`h^1, h^2`, but these are aligned differently in the two places it is used in the equation.
5959
- Facilitate understanding of alignment and broadcasting between elements of parameters/variables with different dimensionality.

0 commit comments

Comments
 (0)