Initializing help system before first use

# SOS.Definition

- java.lang.Object
- - com.dashoptimization.objects.ConstraintDefinition<SOS>
  - - com.dashoptimization.objects.SOS.Definition

- Enclosing class:
    SOS

      public static final class SOS.Definition
      extends ConstraintDefinition<SOS>

  A special ordered set constraint. Instances of this class describe a constraint that has not yet been added but can be added using `XpressProblem.addConstraint()` or `XpressProblem.addConstraints()`. Users should usually not have to deal with this class explicitly.
  Since:
    43.00

- - ### Constructor Summary

    Constructor | Description
    --- | ---
    `Definition​(SetType type, Variable[] items, double[] weights, java.lang.String name)` | Create a new SOS constraint.

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `SOS.Definition` | `setName​(java.lang.String newName)` | Set the name of the constraint.

    - ### Methods inherited from class com.dashoptimization.objects.ConstraintDefinition

      `getName, setConstraintName`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Definition

          public Definition​(SetType type,
                            Variable[] items,
                            double[] weights,
                            java.lang.String name)

      Create a new SOS constraint.
      Parameters:
        `type` - Type of constraint.
        `items` - The elements in this constraint.
        `weights` - Weights for the elements. This can be `null` in which case default weights 1, 2, 3, ... will be used. If not `null` it must have the same length as `items` and values must be unique.
        `name` - Name of the constraint, can be `null`.
      Since:
        43.00

  - ### Method Detail

    - #### setName

          public SOS.Definition setName​(java.lang.String newName)

      Set the name of the constraint. This is the same as `ConstraintDefinition.setConstraintName(String)` but with a different return type.

      Examples using `setName`:

      - Catenary.java
      - ContractAllocation.java
      - CuttingStock.java
      - ELS.java
      - ELSCut.java
      - FolioCB.java
      - FolioHeuristic.java
      - FolioIIS.java
      - FolioInit.java
      - FolioMip1.java
      - FolioMip2.java
      - FolioMipIIS.java
      - FolioQC.java
      - FolioQP.java
      - GeneralConstraints.java
      - MultipleProblems.java
      - ProductionPlanning_Index.java
      - QuadraticProgramming.java
      - RecursiveFinancialPlanning.java
      - Wagon.java
      Parameters:
        `newName` - New name.
      Returns:
        Always returns this instance.
      Since:
        43.00

Parent Topic Class Summary

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.