Skip to content

Commit f4c3c00

Browse files
committed
refer to schema as self-documenting
1 parent 242cae9 commit f4c3c00

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,34 @@ encoded in the form
1616
where `x ∈ ℝᴺ`, `fᵢ: ℝᴺ → ℝ`, and `gⱼ: ℝᴺ → ℝᴹʲ`, and `Sⱼ ⊆ ℝᴹʲ`.
1717

1818
The functions `fᵢ` and `gⱼ`, and sets `Sⱼ` supported by MathOptFormat are
19-
detailed below. This list is not exhaustive. It is intended that MathOptFormat
20-
will be extended in future versions to support additional functions and sets.
19+
defined in the [MathOptFormat schema](#the-schema).
20+
21+
The current list of supported functions and sets is not exhaustive. It is
22+
intended that MathOptFormat will be extended in future versions to support
23+
additional functions and sets.
24+
25+
## The schema
26+
27+
A [JSON schema](http://json-schema.org/) for the `.mof.json` file-format is
28+
provided in the file [`mof.schema.json`](https://github.com/odow/MathOptFormat/blob/master/mof.schema.json).
29+
30+
It is intended for the schema to be self-documenting. Instead of modifying or
31+
adding to this documentation, clarifying edits should be made to the
32+
`description` field of the relevant part of the schema.
33+
34+
### List of supported functions
35+
36+
The list of functions supported by MathOptFormat are contained in the
37+
`#/definitions/scalar_functions` and `#/definitions/vector_functions` fields of
38+
the schema. Scalar functions are functions for which `Mj=1`, while vector
39+
functions are functions for which `Mj≥1`.
40+
41+
### List of supported sets
42+
43+
The list of sets supported by MathOptFormat are contained in the
44+
`#/definitions/scalar_sets` and `#/definitions/vector_sets` fields of the
45+
schema. Scalar sets are sets for which `Mj=1`, while vector sets are sets for
46+
which `Mj≥1`.
2147

2248
## An example
2349

@@ -135,12 +161,7 @@ required keys at the top level:
135161
In this example, the set `[1, ∞)` is the MathOptFormat set `GreaterThan`
136162
with a lower bound of `1`.
137163

138-
## The schema
139-
140-
A [JSON schema](http://json-schema.org/) for the `mof.json` file-format is
141-
provided in the file `mof.schema.json`.
142-
143-
## Examples
164+
### Other examples
144165

145166
A number of examples of optimization problems encoded using MathOptFormat are
146-
provided in the `/examples` directory.
167+
provided in the [`/examples` directory](https://github.com/odow/MathOptFormat/tree/master/examples).

0 commit comments

Comments
 (0)