baobab.bio.permutation
Interface Permutation

All Known Implementing Classes:
ComplexSignedPermutation, SignedPermutation, UnsignedPermutation

public interface Permutation

The Permutation interface represents a general permutation

Version:
1.0, May 2006
Author:
Marilia D. V. Braga

Method Summary
 PermutationFormatter getFormatter()
           
 int getMappedValueOf(int pos)
          Gets the value of the mapped element located at a specified position of the permutation
 int getNumberOfCycles()
           
 Point getPointAt(int pos)
          Gets a point at a specific position of the permutation
 int getPositionOf(int value)
          Gets the position where a specified element of the permutation is located
 int getPositionOfMapped(int value)
          Gets the position where a specified mapped element of the permutation is located
 int getValueOf(int pos)
          Gets the value of the element located at a specified position of the permutation
 boolean isLinear()
          Tests whether the permutation is linear or circular
 boolean isSorted()
           
 int size()
           
 

Method Detail

size

int size()

getNumberOfCycles

int getNumberOfCycles()

isSorted

boolean isSorted()

getFormatter

PermutationFormatter getFormatter()

getPointAt

Point getPointAt(int pos)
Gets a point at a specific position of the permutation

Parameters:
pos - the given position
Returns:
the point at the given position

getMappedValueOf

int getMappedValueOf(int pos)
Gets the value of the mapped element located at a specified position of the permutation

Parameters:
pos - the specified position
Returns:
the value of the mapped element

getValueOf

int getValueOf(int pos)
Gets the value of the element located at a specified position of the permutation

Parameters:
pos - the specified position
Returns:
the value of the element

getPositionOf

int getPositionOf(int value)
Gets the position where a specified element of the permutation is located

Parameters:
value - the value of the specified element
Returns:
the position

getPositionOfMapped

int getPositionOfMapped(int value)
Gets the position where a specified mapped element of the permutation is located

Parameters:
value - the value of the specified mapped element
Returns:
the position

isLinear

boolean isLinear()
Tests whether the permutation is linear or circular

Returns:
true / false