Merge pull request #9 from odow/od/v3

Add SemVer versions

Author: odow

README.md

@@ -39,7 +39,10 @@ Encoded in our standard form, we have
 Encoded into the MathOptFormat file format, this example becomes:
 ```json
 {
- "version": 1,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{"name": "x"}],
  "objectives": [{
  "sense": "min",
@@ -73,8 +76,10 @@ required keys at the top level:
 
  - `"version"`
 
- An integer describing the minimum version of MathOptFormat needed to parse
- the file. This is included to safeguard against later revisions.
+ An object describing the minimum version of MathOptFormat needed to parse
+ the file. This is included to safeguard against later revisions. It contains
+ two fields: `"major"` and `"minor"`. These fields should be interpreted
+ using [SemVer](https://semver.org).
 
  - `"variables"`
 

examples/biobjective.mof.json

@@ -1,6 +1,9 @@
 {
  "description": "The problem: [min{2x - y + 1}, max{y}]",
- "version": 0,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{
  "name": "x"
  }, {
@@ -29,4 +32,4 @@
  }
  }],
  "constraints": []
-}
+}

examples/milp.mof.json

@@ -1,6 +1,9 @@
 {
  "description": "The problem: min{x | x + y >= 1, x ∈ [0, 1], y ∈ {0, 1}}",
- "version": 0,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{
  "name": "x",
  "primal_start": 0.0
@@ -55,4 +58,4 @@
  "head": "ZeroOne"
  }
  }]
-}
+}

examples/nlp.json

@@ -1,6 +1,9 @@
 {
  "description": "The problem: min{2x + sin(x)^2 + y}.",
- "version": 0,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{
  "name": "x"
  }, {
@@ -54,4 +57,4 @@
  }
  }],
  "constraints": []
-}
+}

examples/quadratic.mof.json

@@ -1,6 +1,9 @@
 {
  "description": "The problem: min{x^2 + x * y + y^2}",
- "version": 0,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{
  "name": "x"
  }, {
@@ -32,4 +35,4 @@
  }
  }],
  "constraints": []
-}
+}

examples/vector.json

@@ -1,6 +1,9 @@
 {
  "description": "The problem: min{0 | [1 2; 3 4][x, y] + [5, 6] ∈ R+.",
- "version": 0,
+ "version": {
+ "major": 0,
+ "minor": 3
+ },
  "variables": [{
  "name": "x"
  }, {
@@ -42,4 +45,4 @@
  "dimension": 2
  }
  }]
-}
+}

mof.schema.json

@@ -7,7 +7,16 @@
  "properties": {
  "version": {
  "description": "The version of MathOptFormat that this schema validates against.",
- "const": 0
+ "type": "object",
+ "required": ["minor", "major"],
+ "properties": {
+ "minor": {
+ "const": 3
+ },
+ "major": {
+ "const": 0
+ }
+ }
  },
  "name": {
  "description": "The name of the model.",

mof/.gitignore

@@ -2,3 +2,4 @@
 *.md
 *.bat
 *staticSchema.go
+mof

mof/mof.go

@@ -14,7 +14,8 @@ import (
 
 func main() {
 if len(os.Args) < 2 {
-fmt.Println("Invalid arguments to `mof`. Here is the help:\n")
+fmt.Println("Invalid arguments to `mof`. Here is the help:")
+fmt.Println()
 PrintHelp()
 } else {
 switch os.Args[1] {