Set

public class Set extends Entity<SetInstance> implements java.lang.Iterable<Object>

Represents an AMPL set. In case of not indexed sets, this class exposes functionalities of a Java Set for accessing its elements. The members of the set can be strings, double numbers or tuples.

All these methods throw an UnsupportedOperationException if called for an indexed set.

In case of indexed sets, use the method Set.get to obtain the objects of type SetInstance, from which to access all properties (see section Access to instances and values for further information on how to access set instances).

Data can be assigned to the set using the methods Set.setValues, or using AMPL.setData and an object of class DataFrame.

Methods

public int arity()

The dimension of s, or number of components in each member of this set

public boolean contains(Object o)

Check contents.

See SetInstance.contains.

Valid only for not indexed sets.

Parameters:
  • o – Object to be searched
Returns:

True if the object is present
public boolean containsAll(Collection<? extends Object> c)

Check if the sets contains all the elements in the collection c. Each element in the collection can be a double, a String, a Tuple or an array. In case of arrays, each array is considered as a Tuple.

See SetInstance.containsAll.

Valid only for not indexed sets.

Parameters:
  • c – The collection containing the elements to find.
public SetInstance get()

Get the set instance (for not indexed sets)

Throws:
public final SetInstance get(Object... key)

Get the set instance corresponding to the specified key. See Access to instances and values for further information on how the key can be specified.

Throws:
Returns:

The instance corresponding to the specified key. Null if the specified key is not present.
public final SetInstance get(Tuple key)

Get the set instance corresponding to the specified key (passed as a Tuple). See Access to instances and values for further information on how the key can be specified.

Parameters:
  • key – The indexing tuple of the instance to be found
Throws:
Returns:

The instance corresponding to the specified key. Null if the specified key is not present.
public DataFrame getValues(String... suffixes)

Operation not supported for sets

public DataFrame getValues()

Operation not supported for sets

public boolean isEmpty()

Return true if the set is empty.

Valid only for not indexed sets.

public Iterator<Object> iterator()

If the set is not indexed, get the iterator for this set, allowing easy access to its elements, as in:

ampl.eval("set A := {'a', 'b', 3};");
for (Object o : ampl.getSet("A")) {
    // ...
}
Throws:
public void setValues(Object... objects)

Assign values to the this set.

See SetInstance.setValues for the usage instructions.

public int size()

Get the size of the set (number of elements) (valid only for not indexed sets)

Throws:
public Object[] toArray()

Convert this set to an array.

Valid only for not indexed sets.

public <T> T[] toArray(T[] a)

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.

Valid only for not indexed sets.

Parameters:
  • a – An array of the desired type
public String toString()

String representation of the set. Equivalent to the AMPL statement

show setName;