net.sf.oriented.omi

Interface Chirotope

All Known Subinterfaces:

FullChirotope, OMasChirotope

All Known Implementing Classes:

Alternating

public interface Chirotope

The base interface for implementing new chirotope sources. Typically, clients should be looking for FullChirotope where the contract includes the alternating map. This interface does not provide for an alternating map, and it also counts from 0 rather than from 1.

Author:

jeremycarroll

Method Summary

Methods

Modifier and Type	Method and Description
int	chi(int... i) This is only called when it has rank() arguments, and they are strictly monotonic increasing.
int	n() The number of elements on which this Chirotope is defined
int	rank() Must be a positive integer, which is constant for each object implementing this interface.

Method Detail

chi

int chi(int... i)

This is only called when it has rank() arguments, and they are strictly monotonic increasing. Implementations may return correct values for arguments which are not strictly monotonic increasing but are not required to.

Parameters:

i - an array of rank() integers, between 0 and n()-1.

Returns:

-1, 0 or 1

Throws:

IllegalArgumentException - If arguments are not strictly monotonic increasing, or the wrong number, or out of range.

See Also:

which is not as restricted.

rank

int rank()

Must be a positive integer, which is constant for each object implementing this interface.

Returns:

The rank associated with this chirotope.

n

int n()

The number of elements on which this Chirotope is defined

Returns:

The number of elements on which this Chirotope is defined