Package jgromacs.data

Class IndexSet

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class IndexSet
extends java.lang.Object
implements java.lang.Cloneable
    Objects of this class represent a single index set

    • Constructor Summary

      Constructors 
      Constructor Description
      IndexSet()
      Constructs a new IndexSet object
      IndexSet​(java.lang.String name)
      Constructs a new IndexSet object of a given name
      IndexSet​(java.util.ArrayList<java.lang.Integer> list)
      Constructs a new IndexSet object and loads data from an ArrayList
      IndexSet​(java.util.ArrayList<java.lang.Integer> list, java.lang.String name)
      Constructs a new IndexSet object of a given name and loads data from an ArrayList
      IndexSet​(java.util.TreeSet<java.lang.Integer> set)
      Constructs a new IndexSet object and loads data from a TreeSet
      IndexSet​(java.util.TreeSet<java.lang.Integer> set, java.lang.String name)
      Constructs a new IndexSet object of a given name and loads data from a TreeSet
      IndexSet​(IndexSet set)
      Constructs a new IndexSet object identical to a given IndexSet

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addIndex​(int index)
      Adds a new index to the index set
      java.lang.Object clone()
      Returns an identical IndexSet object
      boolean equals​(java.lang.Object other)
      Returns true if this index sets is identical to another
      java.util.ArrayList<java.lang.Integer> getAsArrayList()
      Returns index set as an ArrayList
      java.util.TreeSet<java.lang.Integer> getAsTreeSet()
      Returns index set as a TreeSet
      java.lang.String getName()
      Returns the name of index set
      int getNumberOfIndices()
      Returns the number of indices in this index set
      int hashCode()
      Returns hash code
      IndexSet intersect​(IndexSet other)
      Returns the intersection of this index set and another
      boolean isIndexIn​(int index)
      Returns true if the index set contains a given index
      void removeIndex​(int index)
      Removes an index from the index set
      void setName​(java.lang.String name)
      Sets the name of index set
      IndexSet subtract​(IndexSet other)
      Returns the subtraction of another index set from this index set
      java.lang.String toString()
      Returns the String representation of index set
      java.lang.String toStringInfo()
      Returns summary information about the index set
      IndexSet union​(IndexSet other)
      Returns the union of this index set and another

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • IndexSet

        public IndexSet()
        Constructs a new IndexSet object

      • IndexSet

        public IndexSet​(java.lang.String name)
        Constructs a new IndexSet object of a given name

      • IndexSet

        public IndexSet​(java.util.ArrayList<java.lang.Integer> list)
        Constructs a new IndexSet object and loads data from an ArrayList

      • IndexSet

        public IndexSet​(java.util.ArrayList<java.lang.Integer> list,
                java.lang.String name)
        Constructs a new IndexSet object of a given name and loads data from an ArrayList

      • IndexSet

        public IndexSet​(java.util.TreeSet<java.lang.Integer> set)
        Constructs a new IndexSet object and loads data from a TreeSet

      • IndexSet

        public IndexSet​(java.util.TreeSet<java.lang.Integer> set,
                java.lang.String name)
        Constructs a new IndexSet object of a given name and loads data from a TreeSet

      • IndexSet

        public IndexSet​(IndexSet set)
        Constructs a new IndexSet object identical to a given IndexSet

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of index set
        Returns:
        Name of index set

      • setName

        public void setName​(java.lang.String name)
        Sets the name of index set

      • getAsTreeSet

        public java.util.TreeSet<java.lang.Integer> getAsTreeSet()
        Returns index set as a TreeSet
        Returns:
        index set as a TreeSet

      • getAsArrayList

        public java.util.ArrayList<java.lang.Integer> getAsArrayList()
        Returns index set as an ArrayList
        Returns:
        index set as an ArrayList

      • getNumberOfIndices

        public int getNumberOfIndices()
        Returns the number of indices in this index set
        Returns:
        number of indices

      • isIndexIn

        public boolean isIndexIn​(int index)
        Returns true if the index set contains a given index

      • addIndex

        public void addIndex​(int index)
        Adds a new index to the index set

      • removeIndex

        public void removeIndex​(int index)
        Removes an index from the index set

      • intersect

        public IndexSet intersect​(IndexSet other)
        Returns the intersection of this index set and another
        Returns:
        intersection of two index sets

      • subtract

        public IndexSet subtract​(IndexSet other)
        Returns the subtraction of another index set from this index set
        Returns:
        subtraction of two index sets

      • union

        public IndexSet union​(IndexSet other)
        Returns the union of this index set and another
        Returns:
        union of two index sets

      • toString

        public java.lang.String toString()
        Returns the String representation of index set
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representation

      • toStringInfo

        public java.lang.String toStringInfo()
        Returns summary information about the index set
        Returns:
        summary information

      • equals

        public boolean equals​(java.lang.Object other)
        Returns true if this index sets is identical to another
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Returns hash code
        Overrides:
        hashCode in class java.lang.Object

      • clone

        public java.lang.Object clone()
        Returns an identical IndexSet object
        Overrides:
        clone in class java.lang.Object
        Returns:
        clone of the index set