edu.rice.hj.api

Interface HjPoint

All Superinterfaces:

Comparable<HjPoint>

All Known Implementing Classes:

Point

public interface HjPoint
extends Comparable<HjPoint>

A point represents an ordered tuplet of n terms, (a0, a1, a2, ..., an-1) where n is the rank of the space in which the point is located. The HjPoint interface provides an immutable view to a point. Access to the individual terms is zero-indexed.

A point variable can hold values of different ranks over its lifetime. e.g.,

   HjPoint p;
   p = newPoint(1);
   ...
   p = newPoint(2, 3);
   ...
 

Author:

Shams Imam (shams@rice.edu)

Method Summary

Modifier and Type	Method and Description
int	get(int index) Read the value in the point at specified rank index.
int	rank() Returns the number of elements in the Point value.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

get

int get(int index)

Read the value in the point at specified rank index.

Parameters:

index - The index of the item to retrieve

Returns:

The value at the specified index

rank

int rank()

Returns the number of elements in the Point value.

Returns:

the number of elements in the Point value.