HashedStorageStructure

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

Type Parameters:
T -

All Implemented Interfaces:

StreamStorageStructure<T>, java.lang.Iterable<T>
```
public class HashedStorageStructure<T extends PrimitiveBasisElement>
extends java.lang.Object
implements StreamStorageStructure<T>
```
This class provides a stream storage mechanism that is based on a multi-layer map. The motivation behind the design of this class is that the ordering of chain basis elements (e.g. simplices) is first determined by filtration index, then by dimension, and then by some other ordering (e.g. lexicographical ordering on the vertices). This storage structure uses a sequence of maps to store a basis element. One can think of it as a tree, where the first node is split on the filtration index, the second layer is split on dimension. This class was inspired by the original version of java plex.

Author:

Andrew Tausz

Constructor Summary

Constructors
Constructor and Description
`HashedStorageStructure(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.

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

- Constructor Detail
  - HashedStorageStructure
```
public HashedStorageStructure(java.util.Comparator<T> basisComparator)
```
    This construction initializes the class with a comparator for comparing the basis elements.
    
    Parameters:
    basisComparator - the comparator
- Method Detail
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T extends PrimitiveBasisElement>
  - 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 extends PrimitiveBasisElement>
    
    Parameters:
    basisElement - the basis element to add
    filtrationIndex - the filtration index of the basis element
  - 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 extends PrimitiveBasisElement>
    
    Parameters:
    basisElement - the basisElement to remove
  - 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 extends PrimitiveBasisElement>
    
    Parameters:
    basisElement - the basis element to query
    
    Returns:
    true if the stream contains the basis element and false otherwise
  - 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 extends PrimitiveBasisElement>
    
    Parameters:
    basisElement - the element to query
    
    Returns:
    the filtration index of the given basis element
  - 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 extends PrimitiveBasisElement>
    
    Returns:
    true if the stream is finalized and false otherwise
  - 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 extends PrimitiveBasisElement>
    
    Returns:
    a Comparator on the basis type
  - 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 extends PrimitiveBasisElement>
    
    Returns:
    the number of elements in the storage structure
  - 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 extends PrimitiveBasisElement>
  - 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 extends PrimitiveBasisElement>
    
    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 extends PrimitiveBasisElement>
    
    Returns:
    the minimum filtration index

Class HashedStorageStructure<T extends PrimitiveBasisElement>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HashedStorageStructure

Method Detail

iterator

addElement

removeElement

containsElement

getFiltrationIndex

isFinalized

getBasisComparator

getSize

finalizeStructure

getMaximumFiltrationIndex

getMinimumFiltrationIndex