Package org.ssclab.pl.milp

Enum SolutionDetail

  • All Implemented Interfaces:
    Serializable, Comparable<SolutionDetail>
    public enum SolutionDetail
extends Enum<SolutionDetail>
    Enumeration SolutionDetail defines optional parts of the solution that can be included in the JSON output when solving a Linear Programming (LP) or Mixed-Integer Linear Programming (MILP) problem. Each value of the enumeration corresponds to a specific part of the solution that may be added to the JSON representation. These details allow for greater customization of the information returned.
    • INCLUDE_BOUNDS: Includes the upper and lower bounds of the variables in the solution.
    • INCLUDE_RELAXED: Adds the relaxed solution to the JSON output, in addition to the integer solution.
    • INCLUDE_CONSTRAINT: Includes the Left-Hand Side (LHS) and Right-Hand Side (RHS) values of the constraints in the solution.
    • INCLUDE_META: Provides metadata about the optimization process, such as execution time, number of threads, number of iterations, etc.
    • INCLUDE_TYPEVAR: Indicates the original type of each variable in the solution (e.g., integer, binary, continuous).
    This enumeration is used as an argument in the getSolutionAsJson method, enabling flexibility in the information presented in the JSON format.

    • Enum Constant Detail

      • INCLUDE_BOUNDS

        public static final SolutionDetail INCLUDE_BOUNDS
        Includes the upper and lower bounds for each variable in the solution.

      • INCLUDE_RELAXED

        public static final SolutionDetail INCLUDE_RELAXED
        Includes the relaxed solution, in addition to the integer solution. The relaxed solution refers to the linear relaxation of the MILP problem.

      • INCLUDE_CONSTRAINT

        public static final SolutionDetail INCLUDE_CONSTRAINT
        Adds the LHS (Left-Hand Side) and RHS (Right-Hand Side) values for the problem's constraints.

      • INCLUDE_META

        public static final SolutionDetail INCLUDE_META
        Provides meta-information about the optimization process, such as execution time, number of iterations, number of threads, and other details.

      • INCLUDE_TYPEVAR

        public static final SolutionDetail INCLUDE_TYPEVAR
        Includes the original type of each variable (e.g., integer, binary, continuous).

    • Method Detail

      • values

        public static SolutionDetail[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SolutionDetail c : SolutionDetail.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SolutionDetail valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null