cpsat-js 1.3.0 → 1.4.0

package/README.md

@@ -89,6 +89,8 @@ if (result.status === CpSolverStatus.OPTIMAL) {
 - `addBoolOr([...literals])` / `addBoolAnd([...literals])` — boolean logic
 - `addNoOverlap([...intervals])` — scheduling / disjunctive constraints
 - `addCircuit([[tail, head, literal], ...])` — routing / TSP
+- `addMultiplicationEquality`, `addDivisionEquality`, `addModuloEquality` — products, integer division, remainders
+- `addMaxEquality` / `addMinEquality` — maximum / minimum of expressions
 - `minimize(expr)` / `maximize(expr)` — optimization objectives
 - `.onlyEnforceIf(literal)` — conditional enforcement (half-reification)
 
@@ -164,9 +166,29 @@ Builder for constraint programming models.
 - `addBoolAnd(literals): Constraint`
 - `addNoOverlap(intervals): Constraint`
 - `addCircuit(arcs): Constraint`
+- `addMultiplicationEquality(target, exprs): Constraint` — `target == exprs[0] * exprs[1] * ...`
+- `addDivisionEquality(target, num, denom): Constraint` — `target == num / denom`, rounded towards zero
+- `addModuloEquality(target, expr, mod): Constraint` — `target == expr % mod`, with `mod > 0`
+- `addMaxEquality(target, exprs): Constraint` / `addMinEquality(target, exprs): Constraint`
 - `minimize(expr)` / `maximize(expr)`
 - `addHint(variable, value)` / `clearHints()` — suggest where the search should start
 
+#### Non-linear constraints
+
+CP-SAT only accepts multiplication, division and modulo over expressions with at most one variable, such as `x`, `x.times(2)` or `x.minus(3)`. Passing `x.plus(y)` throws when the constraint is built. To use it, introduce an intermediate variable:
+
+```ts
+const x = model.newIntVar(0, 10, 'x');
+const y = model.newIntVar(0, 10, 'y');
+const sum = model.newIntVar(0, 20, 'sum');
+const sq = model.newIntVar(0, 400, 'sq');
+
+model.add(sum.equals(x.plus(y)));
+model.addMultiplicationEquality(sq, [sum, sum]); // sq == (x + y)^2
+```
+
+`addMaxEquality` and `addMinEquality` accept any linear expression.
+
 #### Hints
 
 A hint is advisory. It constrains nothing, cannot change the optimal value, and a wrong
@@ -275,6 +297,23 @@ What `onSolution` receives: everything `CpSolverResult` has, including `value()`
 The shape is deliberately the same as a final result, so an incumbent and an answer can
 be read by the same code.
 
+### `cpsat-js/proto`
+
+The protobuf boundary, for solving a model somewhere other than this WASM — native
+OR-Tools reads the same `CpModelProto` bytes:
+
+```ts
+import { toBinary, fromBinary, CpModelProtoSchema, CpSolverResponseSchema } from 'cpsat-js/proto';
+
+const bytes = toBinary(CpModelProtoSchema, model.toProto());
+// ...solve `bytes` elsewhere, get response bytes back...
+const response = fromBinary(CpSolverResponseSchema, responseBytes);
+```
+
+Exports `CpModelProtoSchema`, `CpSolverResponseSchema` and `SatParametersSchema`, with
+`create`/`toBinary`/`fromBinary` re-exported from `@bufbuild/protobuf` so encoding uses the
+same runtime the schemas were generated against.
+
 ## Architecture
 
 - **TypeScript wrapper** builds a `CpModelProto` via a fluent API

package/dist/proto.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The protobuf boundary, for solving a model somewhere other than this WASM —
+ * native OR-Tools, say, which reads the same CpModelProto bytes.
+ *
+ *   import { toBinary, CpModelProtoSchema } from 'cpsat-js/proto';
+ *   const bytes = toBinary(CpModelProtoSchema, model.toProto());
+ *
+ * The protobuf runtime is re-exported with the schemas so a caller encodes with
+ * the same @bufbuild/protobuf instance the schemas were generated against.
+ */
+export { create, toBinary, fromBinary } from '@bufbuild/protobuf';
+export { CpModelProtoSchema, CpSolverResponseSchema } from './generated/cp_model_pb.js';
+export type { CpModelProto, CpSolverResponse } from './generated/cp_model_pb.js';
+export { SatParametersSchema } from './generated/sat_parameters_pb.js';
+export type { SatParameters } from './generated/sat_parameters_pb.js';
+//# sourceMappingURL=proto.d.ts.map

package/dist/proto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto.d.ts","sourceRoot":"","sources":["../src/proto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACxF,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,YAAY,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/proto.js

@@ -0,0 +1,14 @@
+/**
+ * The protobuf boundary, for solving a model somewhere other than this WASM —
+ * native OR-Tools, say, which reads the same CpModelProto bytes.
+ *
+ *   import { toBinary, CpModelProtoSchema } from 'cpsat-js/proto';
+ *   const bytes = toBinary(CpModelProtoSchema, model.toProto());
+ *
+ * The protobuf runtime is re-exported with the schemas so a caller encodes with
+ * the same @bufbuild/protobuf instance the schemas were generated against.
+ */
+export { create, toBinary, fromBinary } from '@bufbuild/protobuf';
+export { CpModelProtoSchema, CpSolverResponseSchema } from './generated/cp_model_pb.js';
+export { SatParametersSchema } from './generated/sat_parameters_pb.js';
+//# sourceMappingURL=proto.js.map

package/dist/proto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto.js","sourceRoot":"","sources":["../src/proto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAExF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpsat-js",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "WebAssembly port of Google OR-Tools CP-SAT constraint programming solver",
   "type": "module",
   "main": "dist/index.portable.js",
@@ -19,6 +19,10 @@
     "./portable": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.portable.js"
+    },
+    "./proto": {
+      "types": "./dist/proto.d.ts",
+      "default": "./dist/proto.js"
     }
   },
   "files": [