edu.unh.sdb.datasource

Class RegularISPartitioning

java.lang.Object

edu.unh.sdb.datasource.ISPartitioning

edu.unh.sdb.datasource.RegularISPartitioning

public class RegularISPartitioning
extends ISPartitioning

This class implements a regular partitioning of a bounded index space. A partitioning divides the space into some number of partitions. For regular partitionings, these partitions are all the same size and shape, except for those that span an edge of the index space.( That is, it is possible that partitions near the edge may be clipped by the index space bounds.) A regular partitioning can be specified either by giving the dimensions of a partition to the constructor, or by specifying how many partitions each axis should be divided into.

Field Summary

Fields

Modifier and Type	Field and Description
protected long[]	axisWeights
protected AxisOrdering	ordering
protected int[]	tempCoords

Fields inherited from class edu.unh.sdb.datasource.ISPartitioning

dimensionality, partitioningBounds, partitioningLowerBounds, partitioningShape, partitioningUpperBounds, partitioningVolume, partitionShape, spaceBounds, spaceLowerBounds, spaceShape, spaceUpperBounds

Constructor Summary

Constructors

Constructor and Description
RegularISPartitioning(IndexSpaceID partitioningShape, ISBounds spaceBounds) Create a regular partition over space, given the desired block size for each partition.
RegularISPartitioning(IndexSpaceID partitioningShape, ISBounds spaceBounds, AxisOrdering ordering) Create a regular partition over space, given the shape of each partition, not the dimensions of the partitioning Space.
RegularISPartitioning(ISBounds partitioningBounds, ISBounds spaceBounds) Create a regular partition over space, given the desired partitioning space
RegularISPartitioning(ISBounds partitioningBounds, ISBounds spaceBounds, AxisOrdering ordering) Create a regular partition over space, given the desired partitioning space and an AxisOrdering

Method Summary

Methods

Modifier and Type	Method and Description
long	containingOffset(IndexSpaceID id) Map the index space id onto the partitioning space and return the 1D offset of the containing partition.
long	elementOffset(IndexSpaceID id) Return the 1D offset of the element specified by the id.
int	getContainingPartitionBoundary(IndexSpaceID id, int axis, boolean upper) If upper is true, return the upper value of the specified axis of the partition containing the id, otherwise, return the lower value.
ISBounds	getContainingPartitionBounds(IndexSpaceID id) Return the bounds of the partition that contains the given id.
ISBounds	getContainingPartitionBounds(IndexSpaceID id, ISBounds bounds) Sets the ISBounds argument to the bounds of the partition in the data space that contains the given id, specified in the data space.
ISBounds	getGeometricBounds() add by xuan
ISBounds	getIndexedBounds(ISBounds bounds, IndexSpaceID partitioningIndex) Sets the argument ISBounds to the space bounds corresponding to the partition defined by the partitioning ID and returns the bounds as well.
ISBounds	getOffsetBounds(ISBounds bounds, long offset) Sets the argument ISBounds to the bounds corresponding to the partition offset.
IndexSpaceID	getOffsetID(IndexSpaceID id, long offset) Sets the argument ISID to the value corresponding to the 1D partition offset.
IndexSpaceID	getOffsetID(long offset) Returns a new ISID corresponding to the 1D partition offset.
int	getPartitionBoundary(IndexSpaceID partitionID, int axis, boolean upper) If upper is true, return the upper value of the specified axis of the partition specified by the partition id, otherwise, return the lower value.
int	getPartitionIndex(IndexSpaceID dataPoint) return the partition index (1D order position of the partitions).
ISBoundsIterator	getPartitionIterator()
ISBoundsIterator	getPartitionIterator(ISBounds subSpace) Create and return an iterator over the partitions that cover the data space bounds defined by the parameter.
ISBoundsIterator	getPartitionIterator(ISBounds subSpace, ISBoundsIterator iter)
static void	main(java.lang.String[] argv)
IndexSpaceID	map(IndexSpaceID dataPoint) Map the id onto the partitioning.
IndexSpaceID	map(IndexSpaceID s, IndexSpaceID d) Map the first argument onto the partitioning, placing the result in the second argument.
ISBounds	map(ISBounds bounds) Map the bounds onto the partitioning, returning a new ISBounds.
ISBounds	mapToSpace(IndexSpaceID partitionID) map partition ID to space ISBounds
ISBounds	mapToSpace(ISBounds partitionBounds) map a partition ISBounds to space ISBounds
ISBounds[]	mapToSpaceParts(ISBounds spaceBnds) Map a bounds in space to the set of spatial bounds that represent the pieces of the bounds that are each only in exactly one partition.
long	partitionOffset(IndexSpaceID partitionId) Map the partitioning space id to its 1D offset.
RegularISPartitioning	project(int axis)
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.

Methods inherited from class edu.unh.sdb.datasource.ISPartitioning

dim, getISIterator, getPartitioningBounds, getPartitioningDimensions, getPartitioningShape, getPartitioningShape, getSpaceBounds, inBounds, inBounds, partitionVolume, setPartitioning, setPartitionShape, setSpaceBounds, volume

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

axisWeights

protected long[] axisWeights

tempCoords

protected int[] tempCoords

ordering

protected AxisOrdering ordering

Constructor Detail

RegularISPartitioning

public RegularISPartitioning(ISBounds partitioningBounds,
                     ISBounds spaceBounds)

Create a regular partition over space, given the desired partitioning space

Parameters:

partitioningBounds -

spaceBounds -

RegularISPartitioning

public RegularISPartitioning(ISBounds partitioningBounds,
                     ISBounds spaceBounds,
                     AxisOrdering ordering)

Create a regular partition over space, given the desired partitioning space and an AxisOrdering

Parameters:

partitioningBounds -

spaceBounds -

ordering -

RegularISPartitioning

public RegularISPartitioning(IndexSpaceID partitioningShape,
                     ISBounds spaceBounds)

Create a regular partition over space, given the desired block size for each partition.

Parameters:

partitionSize -

spaceBounds -

RegularISPartitioning

public RegularISPartitioning(IndexSpaceID partitioningShape,
                     ISBounds spaceBounds,
                     AxisOrdering ordering)

Create a regular partition over space, given the shape of each partition, not the dimensions of the partitioning Space. Also specifies AxisOrdering

Parameters:

partitioningBounds -

spaceBounds -

ordering -

Method Detail

project

public RegularISPartitioning project(int axis)

map

public final IndexSpaceID map(IndexSpaceID dataPoint)

Map the id onto the partitioning.

Specified by:

map in class ISPartitioning

Parameters:

dataPoint - - ISID in data space

Returns:

an ISID in the partitioning space

map

public final IndexSpaceID map(IndexSpaceID s,
               IndexSpaceID d)

Map the first argument onto the partitioning, placing the result in the second argument. A reference to the second id is returned as a convenience.

map

public final ISBounds map(ISBounds bounds)

Map the bounds onto the partitioning, returning a new ISBounds.

Specified by:

map in class ISPartitioning

Parameters:

bounds - - bounds in data space

Returns:

- bounds in partitioning space

containingOffset

public final long containingOffset(IndexSpaceID id)

Map the index space id onto the partitioning space and return the 1D offset of the containing partition. Currently, the default axis ordering is assumed.

elementOffset

public final long elementOffset(IndexSpaceID id)

Return the 1D offset of the element specified by the id. The id should refer to the partitioning space, not the underlying index space.

getGeometricBounds

public ISBounds getGeometricBounds()

add by xuan

mapToSpace

public ISBounds mapToSpace(ISBounds partitionBounds)

map a partition ISBounds to space ISBounds

mapToSpace

public ISBounds mapToSpace(IndexSpaceID partitionID)

map partition ID to space ISBounds

mapToSpaceParts

public ISBounds[] mapToSpaceParts(ISBounds spaceBnds)

Map a bounds in space to the set of spatial bounds that represent the pieces of the bounds that are each only in exactly one partition. This was motivated by needs of SparseDataSource, but could have other uses.

Parameters:

ISBounds: - spaceBnds -- portion of space domain to be mapped

Returns:

ISBounds[]: -- space bounds corresponding to separate partitions

getPartitionBoundary

public final int getPartitionBoundary(IndexSpaceID partitionID,
                       int axis,
                       boolean upper)

If upper is true, return the upper value of the specified axis of the partition specified by the partition id, otherwise, return the lower value.

getContainingPartitionBoundary

public final int getContainingPartitionBoundary(IndexSpaceID id,
                                 int axis,
                                 boolean upper)

If upper is true, return the upper value of the specified axis of the partition containing the id, otherwise, return the lower value.

getContainingPartitionBounds

public final ISBounds getContainingPartitionBounds(IndexSpaceID id)

Return the bounds of the partition that contains the given id.

getPartitionIndex

public int getPartitionIndex(IndexSpaceID dataPoint)

return the partition index (1D order position of the partitions). This can be easily mapped to a seek address, for example.

getContainingPartitionBounds

public final ISBounds getContainingPartitionBounds(IndexSpaceID id,
                                    ISBounds bounds)

Sets the ISBounds argument to the bounds of the partition in the data space that contains the given id, specified in the data space.

getPartitionIterator

public ISBoundsIterator getPartitionIterator()

getPartitionIterator

public ISBoundsIterator getPartitionIterator(ISBounds subSpace)

Description copied from class: ISPartitioning

Create and return an iterator over the partitions that cover the data space bounds defined by the parameter.

Specified by:

getPartitionIterator in class ISPartitioning

Parameters:

subSpace - - region of data space

Returns:

- bounds iterator over the partitions

getPartitionIterator

public ISBoundsIterator getPartitionIterator(ISBounds subSpace,
                                    ISBoundsIterator iter)

getIndexedBounds

public ISBounds getIndexedBounds(ISBounds bounds,
                        IndexSpaceID partitioningIndex)

Sets the argument ISBounds to the space bounds corresponding to the partition defined by the partitioning ID and returns the bounds as well.

Specified by:

getIndexedBounds in class ISPartitioning

getOffsetBounds

public ISBounds getOffsetBounds(ISBounds bounds,
                       long offset)

Sets the argument ISBounds to the bounds corresponding to the partition offset. The ISBounds parameter is returned as a convenience.

getOffsetID

public IndexSpaceID getOffsetID(long offset)

Returns a new ISID corresponding to the 1D partition offset. The ISID refers to the partitioning space, not the index space.

getOffsetID

public IndexSpaceID getOffsetID(IndexSpaceID id,
                       long offset)

Sets the argument ISID to the value corresponding to the 1D partition offset. The ISID refers to the partitioning space, not the index space. The parameter is returned as a convenience.

partitionOffset

public final long partitionOffset(IndexSpaceID partitionId)

Map the partitioning space id to its 1D offset. It uses the partitioning's AxisOrdering to do the mapping. The parameter identifies a position in the partitioning space, not the base space.

toString

public java.lang.String toString()

Return a String representing the object.

Overrides:

toString in class ISPartitioning

toString

public java.lang.String toString(java.lang.String indent)

Return a String representing the object indented by the argument string.

Overrides:

toString in class ISPartitioning

main

public static void main(java.lang.String[] argv)