HjRegion (hjlib-cooperative 0.1.5-SNAPSHOT API)

All Known Subinterfaces:

HjRegion.HjRegion1D, HjRegion.HjRegion2D, HjRegion.HjRegion3D

All Known Implementing Classes:

AbstractRectangularRegion, RectangularRegion1D, RectangularRegion2D, RectangularRegion3D
```
public interface HjRegion
```
A region represents a (sparse or dense) k-dimensional space of points. A convex k-dimensional region is easy to represent, e.g. as a list of k (min, max) pairs.

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`HjRegion.HjRegion1D` Abstraction for a 1-D region.
`static interface`	`HjRegion.HjRegion2D` Abstraction for a 2-D region.
`static interface`	`HjRegion.HjRegion3D` Abstraction for a 3-D region.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Iterator<HjPoint>`	`iterator()` Returns an iterator over an int array whose length is specified by the rank.
`Iterator<HjPoint>`	`iterator(int startLinearIndex, int maxNumItems)` Returns an iterator over an int array whose length is specified by the rank.
`int`	`lowerLimit(int index)` Returns the lower limit of the region at the specified dimension.
`int`	`numElements()` Returns the number of elements in the iteration space defined by the region.
`int`	`rank()` Returns the rank of the region.
`int`	`toLinearIndex(int[] regionIndices)` Returns the zero-based linear index in the 1D array.
`int[]`	`toRegionIndex(int linearIndex)` Return the region based index of the linear index.
`Iterable<HjPoint>`	`toSeqIterable()` The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().
`int`	`upperLimit(int index)` Returns the upper limits of the region at the specified dimension.

- Method Detail
  - toSeqIterable
```
Iterable<HjPoint> toSeqIterable()
```
    The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().
    
    Returns:
    
    an Iterable instance which is safe to use in sequential manner.
  - iterator
```
Iterator<HjPoint> iterator()
```
    Returns an iterator over an int array whose length is specified by the rank. The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().
    
    Returns:
    
    an Iterator.
  - iterator
```
Iterator<HjPoint> iterator(int startLinearIndex,
                           int maxNumItems)
```
    Returns an iterator over an int array whose length is specified by the rank. The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().
    
    Parameters:
    
    startLinearIndex - The starting linear index of the array.
    
    maxNumItems - The maximum number of items in the returned iterator.
    
    Returns:
    
    an Iterator.
  - rank
```
int rank()
```
    Returns the rank of the region.
    
    Returns:
    
    the rank of the region.
  - numElements
```
int numElements()
```
    Returns the number of elements in the iteration space defined by the region.
    
    Returns:
    
    the number of elements in the iteration space defined by the region.
  - lowerLimit
```
int lowerLimit(int index)
```
    Returns the lower limit of the region at the specified dimension.
    
    Returns:
    
    the lower limit of the region at the specified dimension.
  - upperLimit
```
int upperLimit(int index)
```
    Returns the upper limits of the region at the specified dimension.
    
    Returns:
    
    the upper limits of the region at the specified dimension.
  - toRegionIndex
```
int[] toRegionIndex(int linearIndex)
```
    Return the region based index of the linear index. The returned array has the same length as the rank.
    
    Parameters:
    
    linearIndex - The zero-based linear index in the 1D array
    
    Returns:
    
    the region based index of the linear index.
  - toLinearIndex
```
int toLinearIndex(int[] regionIndices)
```
    Returns the zero-based linear index in the 1D array.
    
    Parameters:
    
    regionIndices - The region based index.
    
    Returns:
    
    the zero-based linear index in the 1D array.

Interface HjRegion

Nested Class Summary

Method Summary

Method Detail

toSeqIterable

iterator

iterator

rank

numElements

lowerLimit

upperLimit

toRegionIndex

toLinearIndex