Follow us on Twitter and LinkedIn to get the latest updates from the dev team!
An AMPL entity such as a parameter or a variable. An entity can either represent a single instance of an AMPL algebraic entity or, if the corresponding declaration has an indexing expression, a mapping from keys to instances. In the derived classes, it has methods to access instance-level properties which can be used in case the represented entity is scalar. To gain access to all the values in an entity (for all instances and all suffixes for that entities), use getValues.
getValues
Constructor
Get the AMPL string representation of the sets on which this entity is indexed.
The string representation of the indexing sets for this entity or an empty array if the entity is scalar
Get all the keys in this entity. Not modifiable as a collection.
All the keys currently in the entity.
Get the principal values of this entity as a DataFrame. For variables and objectives it returns their suffix val for parameters it returns their values for constraints it returns the suffix dual for sets it returns all the members of the set
DataFrame
val
dual
All instances
Get all the specified values for this entity as a DataFrame object. The valid strings are all AMPL built-in suffixes for the entity under consideration.
suffixes – A list of suffixes to be returned
IllegalArgumentException – if the specified suffix does not exist.
IllegalArgumentException
A DataFrame object with a column for each indexing set and a column for each one of the specified suffixes.
Check whether this entity is indexed over any set. Equivalent to testing whether Entity.indexarity is greater than zero.
Entity.indexarity
True if the entity is not scalar (is indexed over a set)
Get the indexarity of this entity (sum of the dimensions of the indexing sets). This value indicates how many elements are to be passed to the method BasicEntity.get in order to access an instance of this entity.
BasicEntity.get
See the following AMPL examples:
var x; # indexarity = 0 var y {1..2}; # indexarity = 1 var z {1..2,3..4}; # indexarity = 2 var zz {{(1, 2)}}; # indexarity = 2
The sum of the dimensions of the indexing sets or 0 if the entity is not indexed
Check whether this entity is scalar. Equivalent to testing whether Entity.indexarity is equal to zero.
True if the entity is scalar (not indexed over any set)
Get the AMPL name of this entity
Get the number of instances in this entity
Set the values of this entiy to the correponding values of a DataFrame indexed over the same sets (or a subset). This function assigns the values in the first data column of the passed dataframe to the entity the function is called from. In particular, the statement:: x.setValues(y.getValues()); is semantically equivalent to the AMPL statement:: let {s in S} x[s] := y[s]; *
data –
Get a string representation of this entity; for all entity types, it returns the AMPL declaration.
Get the names of all entities which depend on this one.
An array with the names of all entities which depend on this one.
previous
Tuple
next
BasicEntity