Skip to content

Commit

Permalink
Update build
Browse files Browse the repository at this point in the history
  • Loading branch information
Ivordir committed Mar 11, 2023
1 parent cfb593b commit 69c7475
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions dist/YALPS.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,10 @@ export type OptimizationDirection = "maximize" | "minimize";
*
* @typeparam `VariableKey` - the type of the key used to distinguish variables.
* It should extend `string` if `variables` is an object.
* In the case `variables` is an `Iterable`, duplicate keys are not ignored.
* The order of variables is preserved in the solution,
* but variables that end up having a value of `0` are not included in the solution by default.
*
* @typeparam `ConstraintKey` - the type of the key used to distinguish constraints,
* the objective, and the coefficients on each variable.
* It should extend `string` if `constraints` or any variable's `Coefficients` is an object.
* In the case `constraints` is an `Iterable`, duplicate keys are not ignored.
* Rather, the bounds on the constraints are merged to become the most restrictive.
* However, for duplicate keys in the `Coefficients` of each variable, the last entry is used.
*/
export interface Model<VariableKey = string, ConstraintKey = string> {
/**
Expand All @@ -70,6 +64,8 @@ export interface Model<VariableKey = string, ConstraintKey = string> {
readonly objective?: ConstraintKey;
/**
* An object or `Iterable` representing the constraints of the problem.
* In the case `constraints` is an `Iterable`, duplicate keys are not ignored.
* Rather, the bounds on the constraints are merged to become the most restrictive.
* @see `Constraint`
* @example
* Constraints as an object:
Expand All @@ -95,6 +91,9 @@ export interface Model<VariableKey = string, ConstraintKey = string> {
} : never);
/**
* An object or `Iterable` representing the variables of the problem.
* In the case `variables` is an `Iterable`, duplicate keys are not ignored.
* The order of variables is preserved in the solution,
* but variables that end up having a value of `0` are not included in the solution by default.
* @example
* Variables as an object:
* ```
Expand Down Expand Up @@ -144,7 +143,6 @@ export interface Model<VariableKey = string, ConstraintKey = string> {
export type SolutionStatus = "optimal" | "infeasible" | "unbounded" | "timedout" | "cycled";
/**
* The solution object returned by the solver.
* It includes a status, the final objective result, and the variable amounts.
*/
export type Solution<VariableKey = string> = {
/**
Expand All @@ -162,7 +160,7 @@ export type Solution<VariableKey = string> = {
*
* `"timedout"` indicates that the solver exited early for an integer problem.
* This may happen if the solver takes too long and exceeds the `timeout` option.
* Similarly, the number of branch and cut iterations may exceeed `maxIterations` as set in the options.
* Similarly, the number of branch and cut iterations may exceed `maxIterations` as set in the options.
* In both of these cases, the current sub-optimal solution, if any, is returned.
* If `result` is `NaN`, then this means no integer solutions were found before the solver timed out.
*
Expand Down

0 comments on commit 69c7475

Please sign in to comment.