ISPartitioning

java.lang.Object
- edu.unh.sdb.datasource.ISPartitioning

Direct Known Subclasses:

RegularISPartitioning
```
public abstract class ISPartitioning
extends java.lang.Object
```
An ISPartitioning provides a mapping between an N-Dimensional index space and an integer partitioning Space of the same dimensionality.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`dimensionality`
`protected ISBounds`	`partitioningBounds`
`protected int[]`	`partitioningLowerBounds`
`protected int[]`	`partitioningShape`
`protected int[]`	`partitioningUpperBounds`
`protected int`	`partitioningVolume`
`protected int[]`	`partitionShape`
`protected ISBounds`	`spaceBounds`
`protected int[]`	`spaceLowerBounds`
`protected int[]`	`spaceShape`
`protected int[]`	`spaceUpperBounds`

Constructor Summary

Constructors
Constructor and Description
`ISPartitioning(IndexSpaceID partitionShape, ISBounds spaceBnds)` The first argument specifies the shape of each partition, not the dimensions of the partitioning space.
`ISPartitioning(int[] partitioningDims, ISBounds spaceBnds)` Create an ISPartitioning
`ISPartitioning(ISBounds partitioningBnds, ISBounds spaceBnds)` Create an ISPartitioning from a Bounds describing the partitioning and a Bounds describing the data space.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`dim()`
`abstract ISBounds`	`getIndexedBounds(ISBounds bounds, IndexSpaceID partitioningIndex)` Sets the argument ISBounds to the bounds corresponding to the partition ID.
`ISIterator`	`getISIterator()` Return in IndexSpace iterator over the partitions
`ISBounds`	`getPartitioningBounds()`
`int[]`	`getPartitioningDimensions(int[] dimensions)` Return the dimensions of the partitioning and fill in those dimensions in the passed argument.
`int[]`	`getPartitioningShape()` Return the dimensions of the partitioning
`int[]`	`getPartitioningShape(int[] dimensions)` Return the dimensions of the partitioning and fill in those dimensions in the passed argument.
`abstract ISBoundsIterator`	`getPartitionIterator(ISBounds subSpace)` Create and return an iterator over the partitions that cover the data space bounds defined by the parameter.
`ISBounds`	`getSpaceBounds()` Return the bounds of the data space underlying the partitioning
`boolean`	`inBounds(IndexSpaceID pid)` Return true if the argument represents a partition coordinate that is within the bounds of this partitioning.
`boolean`	`inBounds(int[] coords)` Return true if the argument represents a partition coordinate that is within the bounds of this partitioning.
`abstract IndexSpaceID`	`map(IndexSpaceID dataISID)` Map a position in the data space to the partition that contains it.
`abstract ISBounds`	`map(ISBounds dataBounds)` Map a bounds in the data space to the bounds in the partitioning space that contains the data bounds.
`long`	`partitionVolume()` Return the volume of a single complete partition.
`protected void`	`setPartitioning(ISBounds partitioningBnds)` Define the partitioning from an ISBounds.
`protected void`	`setPartitionShape(IndexSpaceID shapeOfEachPartition)` Define the partitioning by defining the shape of each partition
`protected void`	`setSpaceBounds(ISBounds spaceBnds)` Define the space bounds for the partitioning.
`java.lang.String`	`toString()` Return a String representing the object.
`java.lang.String`	`toString(java.lang.String indent)` Return a String representing the object indented by the argument string.
`long`	`volume()` Return the total number of partitions.

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

- Field Detail
  - dimensionality
```
protected int dimensionality
```
  - partitioningBounds
```
protected ISBounds partitioningBounds
```
  - partitioningVolume
```
protected int partitioningVolume
```
  - partitioningLowerBounds
```
protected int[] partitioningLowerBounds
```
  - partitioningUpperBounds
```
protected int[] partitioningUpperBounds
```
  - partitioningShape
```
protected int[] partitioningShape
```
  - partitionShape
```
protected int[] partitionShape
```
  - spaceBounds
```
protected ISBounds spaceBounds
```
  - spaceLowerBounds
```
protected int[] spaceLowerBounds
```
  - spaceUpperBounds
```
protected int[] spaceUpperBounds
```
  - spaceShape
```
protected int[] spaceShape
```
- Constructor Detail
  - ISPartitioning
```
public ISPartitioning(ISBounds partitioningBnds,
              ISBounds spaceBnds)
```
    Create an ISPartitioning from a Bounds describing the partitioning and a Bounds describing the data space.
    
    Parameters:
    partitioningBounds -
    spaceBounds -
  - ISPartitioning
```
public ISPartitioning(IndexSpaceID partitionShape,
              ISBounds spaceBnds)
```
    The first argument specifies the shape of each partition, not the dimensions of the partitioning space. The second argument specifies the bounds of the data space.
  - ISPartitioning
```
public ISPartitioning(int[] partitioningDims,
              ISBounds spaceBnds)
```
    Create an ISPartitioning
    
    Parameters:
    partitioningDims - - the number of partitions in each dimension. So [8, 6, 5] means there are 8x6x5 partitions
    spaceBounds - - the data space bounds over which the partitioning occurs.
- Method Detail
  - setSpaceBounds
```
protected void setSpaceBounds(ISBounds spaceBnds)
```
    Define the space bounds for the partitioning.
  - setPartitioning
```
protected void setPartitioning(ISBounds partitioningBnds)
```
    Define the partitioning from an ISBounds.
  - setPartitionShape
```
protected void setPartitionShape(IndexSpaceID shapeOfEachPartition)
```
    Define the partitioning by defining the shape of each partition
  - dim
```
public final int dim()
```
    Returns:
    the dimensionality of the partitioning
  - getPartitioningBounds
```
public ISBounds getPartitioningBounds()
```
    Returns:
    the Bounds of the partitioning
  - inBounds
```
public final boolean inBounds(IndexSpaceID pid)
```
    Return true if the argument represents a partition coordinate that is within the bounds of this partitioning. This is a partitioning space operation, not an index space operation.
  - inBounds
```
public final boolean inBounds(int[] coords)
```
    Return true if the argument represents a partition coordinate that is within the bounds of this partitioning. This is a partitioning space operation, not an index space operation.
  - getPartitioningDimensions
```
public int[] getPartitioningDimensions(int[] dimensions)
```
    Return the dimensions of the partitioning and fill in those dimensions in the passed argument.
    
    Parameters:
    dimensions - -- if not null, fill in with partitioning dimensions
    
    Returns:
    the partitioning dimensions
  - getPartitioningShape
```
public int[] getPartitioningShape()
```
    Return the dimensions of the partitioning
    
    Returns:
    the partitioning dimensions
  - getPartitioningShape
```
public int[] getPartitioningShape(int[] dimensions)
```
    Return the dimensions of the partitioning and fill in those dimensions in the passed argument.
    
    Parameters:
    dimensions - -- if not null, fill in with partitioning dimensions
    
    Returns:
    the partitioning dimensions
  - getSpaceBounds
```
public ISBounds getSpaceBounds()
```
    Return the bounds of the data space underlying the partitioning
    
    Returns:
    data space bounds
  - getPartitionIterator
```
public abstract ISBoundsIterator getPartitionIterator(ISBounds subSpace)
```
    Create and return an iterator over the partitions that cover the data space bounds defined by the parameter.
    
    Parameters:
    subSpace - - region of data space
    
    Returns:
    - bounds iterator over the partitions
  - getISIterator
```
public ISIterator getISIterator()
```
    Return in IndexSpace iterator over the partitions
    
    Returns:
    index space iterator
  - map
```
public abstract IndexSpaceID map(IndexSpaceID dataISID)
```
    Map a position in the data space to the partition that contains it.
    
    Parameters:
    dataISID - - ISID in data space
    
    Returns:
    an ISID in the partitioning space
  - map
```
public abstract ISBounds map(ISBounds dataBounds)
```
    Map a bounds in the data space to the bounds in the partitioning space that contains the data bounds.
    
    Parameters:
    dataBounds - - bounds in data space
    
    Returns:
    - bounds in partitioning space
  - getIndexedBounds
```
public abstract ISBounds getIndexedBounds(ISBounds bounds,
                        IndexSpaceID partitioningIndex)
```
    Sets the argument ISBounds to the bounds corresponding to the partition ID.
  - toString
```
public java.lang.String toString()
```
    Return a String representing the object.
    
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String indent)
```
    Return a String representing the object indented by the argument string.
  - volume
```
public long volume()
```
    Return the total number of partitions.
  - partitionVolume
```
public long partitionVolume()
```
    Return the volume of a single complete partition. Partial partitions will not have this volume.

Class ISPartitioning

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dimensionality

partitioningBounds

partitioningVolume

partitioningLowerBounds

partitioningUpperBounds

partitioningShape

partitionShape

spaceBounds

spaceLowerBounds

spaceUpperBounds

spaceShape

Constructor Detail

ISPartitioning

ISPartitioning

ISPartitioning

Method Detail

setSpaceBounds

setPartitioning

setPartitionShape

dim

getPartitioningBounds

inBounds

inBounds

getPartitioningDimensions

getPartitioningShape

getPartitioningShape

getSpaceBounds

getPartitionIterator

getISIterator

map

map

getIndexedBounds

toString

toString

volume

partitionVolume