Skip to content

Commit 9bff84f

Browse files
Update README
1 parent 312a1f7 commit 9bff84f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -147,16 +147,12 @@ In this section we define the core pieces of the IR and what they mean.
147147

148148
### Variables
149149

150-
The simplest piece of the IR is the `Variable`. The `Variable` is the
150+
The most fundamental part of the IR is the `Variable`. The `Variable` is the
151151
context-aware single variable of the IR. Its fields are described as follows:
152152

153153
- `name`: the name of the `Variable`. Note that this is not necessarily
154154
the same as the name of the Julia variable. But this symbol itself is considered
155155
the core identifier of the `Variable` in the sense of equality.
156-
- `value`: the value of the `Variable`. The meaning of the value can be
157-
interpreted differently for different systems, but in most cases it's tied to
158-
whatever value information would be required for the system to be well-defined
159-
such as the initial condition of a differential equation.
160156
- `value_type`: the type that the values have to be. It's disconnected
161157
from the `value` because in many cases the `value` may not be able to be
162158
specified in advance even when we may already know the type. This can be used
@@ -179,6 +175,10 @@ context-aware single variable of the IR. Its fields are described as follows:
179175
- `context`: this is an open field for DSLs to carry along more context
180176
in the variables, but is not used in the systems themselves.
181177

178+
### Constants
179+
180+
`Constant` is a simple wrapper type to store numerical Julia constants.
181+
182182
### Operations
183183

184184
Operations are the basic composition of variables and puts together the pieces

0 commit comments

Comments
 (0)