SortedStorageStructure

java.lang.Object
- edu.stanford.math.plex4.streams.storage_structures.SortedStorageStructure<T>

Type Parameters:
T - the underlying basis type

All Implemented Interfaces:

StreamStorageStructure<T>, java.lang.Iterable<T>
```
public class SortedStorageStructure<T>
extends java.lang.Object
implements StreamStorageStructure<T>
```
This class implements an in-memory stream storage mechanism where all of the elements are held in an in-memory collection in fully sorted order. It implements the StreamStorageStructure interface.

Author:

Andrew Tausz

Constructor Summary

Constructors
Constructor and Description
`SortedStorageStructure(java.util.Comparator<T> basisComparator)` This construction initializes the class with a comparator for comparing the basis elements.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addElement(T basisElement, int filtrationIndex)` This function adds the given basis element to the storage structure, with the supplied filtration index.
`boolean`	`containsElement(T basisElement)` This function returns true if the stream contains the given basis element, and false otherwise.
`void`	`finalizeStructure()` This function sets the stream as being finalized.
`java.util.Comparator<T>`	`getBasisComparator()` This function returns a Comparator object used to define the ordering on the basis type.
`int`	`getFiltrationIndex(T basisElement)` This function returns the filtration index of the given basis element.
`int`	`getMaximumFiltrationIndex()` This function gets the maximum filtration index in the complex.
`int`	`getMinimumFiltrationIndex()` This function gets the minimum filtration index in the complex.
`int`	`getSize()` This function returns the number of elements in the storage structure.
`boolean`	`isFinalized()` This function returns true if the stream has been finalized.
`java.util.Iterator<T>`	`iterator()`
`void`	`removeElement(T basisElement)` This function removes the specified element form the storage structure.
`java.lang.String`	`toString()`
`void`	`updateOrAddElement(T basisElement, int newFiltrationValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SortedStorageStructure
```
public SortedStorageStructure(java.util.Comparator<T> basisComparator)
```
    This construction initializes the class with a comparator for comparing the basis elements.
    
    Parameters:
    basisComparator - the comparator
- Method Detail
  - addElement
```
public void addElement(T basisElement,
              int filtrationIndex)
```
    Description copied from interface: StreamStorageStructure
    
    This function adds the given basis element to the storage structure, with the supplied filtration index.
    
    Specified by:
    
    addElement in interface StreamStorageStructure<T>
    
    Parameters:
    basisElement - the basis element to add
    filtrationIndex - the filtration index of the basis element
  - updateOrAddElement
```
public void updateOrAddElement(T basisElement,
                      int newFiltrationValue)
```
  - removeElement
```
public void removeElement(T basisElement)
```
    Description copied from interface: StreamStorageStructure
    
    This function removes the specified element form the storage structure. In the case that the element is not present in the stream, this function throws an IllegalArgumentException.
    
    Specified by:
    
    removeElement in interface StreamStorageStructure<T>
    
    Parameters:
    basisElement - the basisElement to remove
  - isFinalized
```
public boolean isFinalized()
```
    Description copied from interface: StreamStorageStructure
    
    This function returns true if the stream has been finalized.
    
    Specified by:
    
    isFinalized in interface StreamStorageStructure<T>
    
    Returns:
    true if the stream is finalized and false otherwise
  - finalizeStructure
```
public void finalizeStructure()
```
    Description copied from interface: StreamStorageStructure
    
    This function sets the stream as being finalized. A finalized storage structure cannot accept any more elements, and should be ready for consumption.
    
    Specified by:
    
    finalizeStructure in interface StreamStorageStructure<T>
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - getFiltrationIndex
```
public int getFiltrationIndex(T basisElement)
```
    Description copied from interface: StreamStorageStructure
    
    This function returns the filtration index of the given basis element.
    
    Specified by:
    
    getFiltrationIndex in interface StreamStorageStructure<T>
    
    Parameters:
    basisElement - the element to query
    
    Returns:
    the filtration index of the given basis element
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getBasisComparator
```
public java.util.Comparator<T> getBasisComparator()
```
    Description copied from interface: StreamStorageStructure
    
    This function returns a Comparator object used to define the ordering on the basis type.
    
    Specified by:
    
    getBasisComparator in interface StreamStorageStructure<T>
    
    Returns:
    a Comparator on the basis type
  - containsElement
```
public boolean containsElement(T basisElement)
```
    Description copied from interface: StreamStorageStructure
    
    This function returns true if the stream contains the given basis element, and false otherwise.
    
    Specified by:
    
    containsElement in interface StreamStorageStructure<T>
    
    Parameters:
    basisElement - the basis element to query
    
    Returns:
    true if the stream contains the basis element and false otherwise
  - getSize
```
public int getSize()
```
    Description copied from interface: StreamStorageStructure
    
    This function returns the number of elements in the storage structure.
    
    Specified by:
    
    getSize in interface StreamStorageStructure<T>
    
    Returns:
    the number of elements in the storage structure
  - getMaximumFiltrationIndex
```
public int getMaximumFiltrationIndex()
```
    Description copied from interface: StreamStorageStructure
    
    This function gets the maximum filtration index in the complex.
    
    Specified by:
    
    getMaximumFiltrationIndex in interface StreamStorageStructure<T>
    
    Returns:
    the maximum filtration index
  - getMinimumFiltrationIndex
```
public int getMinimumFiltrationIndex()
```
    Description copied from interface: StreamStorageStructure
    
    This function gets the minimum filtration index in the complex.
    
    Specified by:
    
    getMinimumFiltrationIndex in interface StreamStorageStructure<T>
    
    Returns:
    the minimum filtration index

Class SortedStorageStructure<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SortedStorageStructure

Method Detail

addElement

updateOrAddElement

removeElement

isFinalized

finalizeStructure

iterator

getFiltrationIndex

toString

getBasisComparator

containsElement

getSize

getMaximumFiltrationIndex

getMinimumFiltrationIndex