SetInstance

public class SetInstance extends Instance implements Iterable<Object>

A SetInstance object stores the information regarding a specific instance of a set. The instances can be accessed through the function Set.get of the parent entity.

The members of the set can be strings, double numbers or tuples.

Data can be assigned using Set.setValues or using AMPL.setData and a DataFrame object.

All the accessors in this class throw a IllegalStateException if the instance has been deleted in the underlying AMPL interpreter.

Fields

_impl

SetInstanceBase _impl

Constructors

SetInstance

protected SetInstance(long cPtr, boolean cMemoryOwn)

SetInstance

SetInstance(SetInstanceBase impl)

Methods

contains

public boolean contains(Object o)

Check contents of the set for members. The object to be found can be a String, a double, a Tuple or an array. In this last case, each element in the array is considered as elements of a Tuple to be found.

i.e. the following are equivalent:

contains(new Tuple(1, "abc"));

and

contains(new Object[]{1, "abc});
Parameters:
  • o – Object to be found (double, String, Tuple or Object[] with the elements of a tuple)
Returns:

True if the object is present.

containsAll

public boolean containsAll(Collection<?> 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.

Example: considering the AMPL set declared as

set s := {(1, 'abc'), ('def', 2)};

the following is true:

List<Object> l = new LinkedList<Object>();
list.add(new Tuple("def", 2));
list.add(new Object[] { 1, "abc" });
ampl.getSet("s").get().containsAll(list);
Parameters:
  • c – A Collection of objects to be found. See above for the semantics of the objects.
Returns:

True if all the specified objects are present

containsAll

public boolean containsAll(double[] c)

containsAll

public boolean containsAll(int[] c)

containsAll

public boolean containsAll(String[] c)

getValues

public DataFrame getValues()

Get all the members of this set in a DataFrame

iterator

public Iterator<Object> iterator()

setValues

public void setValues(Tuple[] objects)

Assign values to the this set. The values can be strings, doubles, tuples or arrays of objects (which will be converted into tuples).

For example, to assign values to a set of tuples:

ampl.eval("set s dimen 2;");
Set s = ampl.getSet("s");
Object[] data = new Object[] { new Tuple(1, "abc"), new Tuple(2, "def") };
s.setValues(data);

or alternatively, using arrays of objects:

ampl.eval("set s dimen 2;");
Set s = ampl.getSet("s");
Object[] data = new Object[] {new Object[]{1, "abc"}, new Object{2, "def"}};
s.setValues(data);
Parameters:
  • objects – Values to be assigned to the set

setValues

public void setValues(Tuple value)

setValues

public void setValues(DataFrame data)

setValuesFlattened

public void setValuesFlattened(double... objects)

An alternative way to assign values to a set of tuples of size n is to use a flattened array, in which every n elements are considered a Tuple. So, an equivalent formulation of the example above is:

ampl.eval("set s dimen 2;");
Set s = ampl.getSet("s");
Object[] data = new Object[] { 1, "abc", 2, "def" };
s.setValues(data);
Parameters:
  • objects

setValuesFlattened

public void setValuesFlattened(String... objects)

size

public int size()

Get the size

Returns:Cardinality of this set

toArray

public Object[] toArray()

Convert this set to an array.

Valid only for not indexed sets.

toSet

public java.util.Set<Object> toSet()

Convert this set to an java set.

Valid only for not indexed sets.

toString

public String toString()

Converts the set to string, showing its name, its index value and its members.