VariableBuilder.VariableMap5Builder

java.lang.Object
- com.dashoptimization.VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>

Enclosing class:: VariableBuilder

public static class VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>
extends java.lang.Object

Build a 5-dimensional map of variables.

Since:: 43.00

Constructor Summary

Constructor	Description
`VariableMap5Builder(java.util.Collection<K1> coll1, java.util.Collection<K2> coll2, java.util.Collection<K3> coll3, java.util.Collection<K4> coll4, java.util.Collection<K5> coll5, XpressProblem prob)`	Create a builder that will create a 5-dimensional map of variables from the specified data.
`VariableMap5Builder(K1[] arr1, K2[] arr2, K3[] arr3, K4[] arr4, K5[] arr5, XpressProblem prob)`	Create a builder that will create a 5-dimensional map of variables from the specified arrays.

Method Summary

Modifier and Type	Method	Description
`HashMap5<K1,K2,K3,K4,K5,Variable>`	`toMap()`	Create the variables specified by this builder.
`<I> I`	`toMap(java.util.function.Supplier<I> makeResult, Action7<I,K1,K2,K3,K4,K5,Variable> addResult)`	Create the variables specified by this builder.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withFilter(Function5<K1,K2,K3,K4,K5,java.lang.Boolean> filter)`	Set a filter that selects elements.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withLB(double lb)`	Set a constant lower bound for all variables.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withLB(Function5<K1,K2,K3,K4,K5,java.lang.Double> lb)`	Set a lower bound that depends on the index.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withLimit(double limit)`	Set a constant limit for all variables.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withLimit(Function5<K1,K2,K3,K4,K5,java.lang.Double> limit)`	Set a limit that depends on the index.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withName(Function5<K1,K2,K3,K4,K5,java.lang.String> name)`	Set a name that depends on the index.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withName(java.lang.String name)`	Set a constant name for all variables.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withType(ColumnType type)`	Set a constant type for all variables.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withType(Function5<K1,K2,K3,K4,K5,ColumnType> type)`	Set a type that depends on the index.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withUB(double ub)`	Set a constant upper bound for all variables.
`VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5>`	`withUB(Function5<K1,K2,K3,K4,K5,java.lang.Double> ub)`	Set a upper bound that depends on the index.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VariableMap5Builder
```
public VariableMap5Builder(java.util.Collection<K1> coll1,
                           java.util.Collection<K2> coll2,
                           java.util.Collection<K3> coll3,
                           java.util.Collection<K4> coll4,
                           java.util.Collection<K5> coll5,
                           XpressProblem prob)
```
    Create a builder that will create a 5-dimensional map of variables from the specified data.
    
    Parameters:
    
    coll1 - Data for the builder.
    
    coll2 - Data for the builder.
    
    coll3 - Data for the builder.
    
    coll4 - Data for the builder.
    
    coll5 - Data for the builder.
    
    prob - The problem for which to create variables.
    
    Since:
    
    43.00
  - VariableMap5Builder
```
public VariableMap5Builder(K1[] arr1,
                           K2[] arr2,
                           K3[] arr3,
                           K4[] arr4,
                           K5[] arr5,
                           XpressProblem prob)
```
    Create a builder that will create a 5-dimensional map of variables from the specified arrays.
    
    Parameters:
    
    arr1 - Data for the builder.
    
    arr2 - Data for the builder.
    
    arr3 - Data for the builder.
    
    arr4 - Data for the builder.
    
    arr5 - Data for the builder.
    
    prob - The problem for which to create variables.
    
    Since:
    
    43.00
- Method Detail
  - withLB
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withLB(Function5<K1,K2,K3,K4,K5,java.lang.Double> lb)
```
    Set a lower bound that depends on the index.
    
    Parameters:
    
    lb - The lower bound for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withLB
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withLB(double lb)
```
    Set a constant lower bound for all variables.
    
    Parameters:
    
    lb - The lower bound for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withUB
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withUB(Function5<K1,K2,K3,K4,K5,java.lang.Double> ub)
```
    Set a upper bound that depends on the index.
    
    Parameters:
    
    ub - The upper bound for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withUB
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withUB(double ub)
```
    Set a constant upper bound for all variables.
    
    Parameters:
    
    ub - The upper bound for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withLimit
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withLimit(Function5<K1,K2,K3,K4,K5,java.lang.Double> limit)
```
    Set a limit that depends on the index. A limit specifies the bounds for semi-continuous/integer variables and the limit for partial integer variables. It does not apply to variables of other types.
    
    Parameters:
    
    limit - The limit for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withLimit
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withLimit(double limit)
```
    Set a constant limit for all variables. A limit specifies the bounds for semi-continuous/integer variables and the limit for partial integer variables. It does not apply to variables of other types.
    
    Parameters:
    
    limit - The limit for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withName
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withName(Function5<K1,K2,K3,K4,K5,java.lang.String> name)
```
    Set a name that depends on the index.
    
    Parameters:
    
    name - The name for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withName
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withName(java.lang.String name)
```
    Set a constant name for all variables.
    
    Parameters:
    
    name - The name for all variables created by this builder. This must be null or a format string that will be invoked with the index as argument.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withType
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withType(Function5<K1,K2,K3,K4,K5,ColumnType> type)
```
    Set a type that depends on the index.
    
    Parameters:
    
    type - The type for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withType
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withType(ColumnType type)
```
    Set a constant type for all variables.
    
    Parameters:
    
    type - The type for all variables created by this builder.
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - withFilter
```
public VariableBuilder.VariableMap5Builder<K1,K2,K3,K4,K5> withFilter(Function5<K1,K2,K3,K4,K5,java.lang.Boolean> filter)
```
    Set a filter that selects elements.
    
    Parameters:
    
    filter - Element filter
    
    Returns:
    
    Always returns this instance.
    
    Since:
    
    43.00
  - toMap
```
public HashMap5<K1,K2,K3,K4,K5,Variable> toMap()
```
    Create the variables specified by this builder.
    
    Returns:
    
    The created variables.
    
    Since:
    
    43.00
  - toMap
```
public <I> I toMap(java.util.function.Supplier<I> makeResult,
                   Action7<I,K1,K2,K3,K4,K5,Variable> addResult)
```
    Create the variables specified by this builder.
    
    Type Parameters:
    
    I - Type of result
    
    Parameters:
    
    makeResult - Function to create an (empty) result.
    
    addResult - Function to add an element to the result.
    
    Returns:
    
    The created variables.
    
    Since:
    
    43.00

© 2001-2024 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.

Contents

Index

Glossary

Search Results

VariableBuilder.VariableMap5Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VariableMap5Builder

VariableMap5Builder

Method Detail

withLB

withLB

withUB

withUB

withLimit

withLimit

withName

withName

withType

withType

withFilter

toMap

toMap