SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | List of all members
CoordinateSet Class Referenceabstract

Represents a set of coordinates. More...

Inheritance diagram for CoordinateSet:
[legend]

Public Member Functions

abstract List< Integer > asList ()
 
abstract int maxCoordinate ()
 Returns the maximum coordinate index, starting at 0 for the first coordinate.
 
abstract List< CoordinateSetsubsets (boolean includeEmptySet, int maxOrder)
 Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder.
 
boolean equals (Object o)
 
boolean contains (int coord)
 Returns true if the current set contains coordinate coord. More...
 
boolean containsAll (CoordinateSet cs)
 Returns true if the current set contains all coordinates in cs. More...
 
int cardinality ()
 Returns the cardinality of the current coordinate set. More...
 
boolean isSubset (CoordinateSet cs)
 Returns true if cs is a subset of the current coordinate set.
 
List< CoordinateSetsubsets ()
 Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder. More...
 
List< CoordinateSetsubsetsNotEmpty ()
 Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder. More...
 
List< CoordinateSetsubsets (int maxOrder)
 Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder. More...
 
List< CoordinateSetsubsetsNotEmpty (int maxOrder)
 Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder. More...
 
String toString ()
 

Detailed Description

Represents a set of coordinates.

Coordinate indices start at 0.

Member Function Documentation

◆ cardinality()

int cardinality ( )

Returns the cardinality of the current coordinate set.

Subclasses should override this method. The default implementation is inefficient.

◆ contains()

boolean contains ( int  coord)

Returns true if the current set contains coordinate coord.

Subclasses should override this method.

◆ containsAll()

boolean containsAll ( CoordinateSet  cs)

Returns true if the current set contains all coordinates in cs.

Subclasses should override this method. The default implementation is inefficient.

◆ subsets() [1/2]

List<CoordinateSet> subsets ( )

Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder.

Includes the empty sets.

◆ subsets() [2/2]

List<CoordinateSet> subsets ( int  maxOrder)

Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder.

Includes the empty set.

◆ subsetsNotEmpty() [1/2]

List<CoordinateSet> subsetsNotEmpty ( )

Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder.

Does not include the empty set.

◆ subsetsNotEmpty() [2/2]

List<CoordinateSet> subsetsNotEmpty ( int  maxOrder)

Returns all subsets of the current coordinate set, whose cardinality is at most maxOrder.

Does not include the empty set.


The documentation for this class was generated from the following file: