fr.inria.aoste.kpassa.util

Class BinaryWord

java.lang.Object

fr.inria.aoste.kpassa.util.BinaryWord

public class BinaryWord
extends java.lang.Object

A binary word is a list of boolean. BinaryWord are used to represent the markings of the Arc and the schedule of the Vertex.

Author:

jvmillo

See Also:

Arc, Vertex, SMGArcMarking, SMGVertexSchedule

Constructor Summary

Constructors

Constructor and Description
BinaryWord() To build an empty word.
BinaryWord(java.lang.Boolean withToken) To build a word with a single bit.
BinaryWord(int value, int size) Create a binary word where the decimal value is given by @param value and the size is given by @param size.
BinaryWord(java.lang.String word) To build the word that is given as a String.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAtBegin(java.lang.Boolean value) To add a bit at the begin of the word (on the left hand side).
void	addAtEnd(java.lang.Boolean value) To add a bit at the end of the word (on the right hand side).
void	addToListeners(BinaryWordListener listener) To add a listener to the list of listeners.
BinaryWord	clone() To clone the binary word.
BinaryWord	complement() To get the complement of the word.
boolean	contains(boolean b) To check whether the word contains at least one bit with the value of b.
boolean	equals(java.lang.Object word2) It test whether words is an instance of BinaryWord.
static int	getAlpha(int k, int p) To get the value alpha.
int	getNBofTrueValue() To get the number of true value in the word
static BinaryWord	getTheMaxBalancedBinaryWord(int k, int p) Generate the maximal balanced binary word of length p containing k true value.
static BinaryWord	getTheMinBalancedBinaryWord(int k, int p) Generate the minimal balanced binary word of length p containing k true value.
boolean	getValue(int index) To get the i th value of the word.
int	intValue() Return the value of the word in base 10.
boolean	isInferiorTo(BinaryWord word2) To check whether this is inferior to word2
boolean	isSuperiorTo(BinaryWord word2) To check whether this is superior to word2
void	removeLast() To remove the last element of the word
BinaryWord	rotate(int indexTowardRight) To rotate the word toward right.
int	size() To get the size of the word.
BinaryWord	subVector(int startIndex) To get a suffix of the word starting at the index given in parameter.
BinaryWord	subVector(int startIndex, int endIndex) To get a factor of the word starting and terminating at the index given in parameters.
java.lang.String	toString() To get the binary word as a String.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryWord

@API
public BinaryWord()

To build an empty word.

BinaryWord

@API
public BinaryWord(java.lang.Boolean withToken)

To build a word with a single bit.

Parameters:

withToken - the value of the bit

BinaryWord

@API
public BinaryWord(java.lang.String word)

To build the word that is given as a String.

Parameters:

word - the word as a String.

BinaryWord

@API
public BinaryWord(int value,
              int size)
           throws MalformedBinaryWordException

Create a binary word where the decimal value is given by @param value and the size is given by @param size.

Parameters:

value - the value in base 10 of he binary word

size - The number of bits of the resulting word

Throws:

MalformedBinaryWordException

Method Detail

clone

@API
public BinaryWord clone()

To clone the binary word.

Overrides:

clone in class java.lang.Object

toString

@API
public java.lang.String toString()

To get the binary word as a String.

Overrides:

toString in class java.lang.Object

addToListeners

@API
public void addToListeners(BinaryWordListener listener)

To add a listener to the list of listeners.

Parameters:

listener - the listener to add

addAtBegin

@API
public void addAtBegin(java.lang.Boolean value)

To add a bit at the begin of the word (on the left hand side).

Parameters:

value - the bit to add

addAtEnd

@API
public void addAtEnd(java.lang.Boolean value)

To add a bit at the end of the word (on the right hand side).

Parameters:

value - the bit to add

removeLast

@API
public void removeLast()

To remove the last element of the word

getValue

@API
public boolean getValue(int index)

To get the i th value of the word.

Parameters:

index - the index i

Returns:

the i th value

size

@API
public int size()

To get the size of the word.

Returns:

the size

getNBofTrueValue

@API
public int getNBofTrueValue()

To get the number of true value in the word

Returns:

the number

subVector

@API
public BinaryWord subVector(int startIndex,
                       int endIndex)

To get a factor of the word starting and terminating at the index given in parameters.

Parameters:

startIndex - the starting index

endIndex - the terminating index

Returns:

the factor

subVector

@API
public BinaryWord subVector(int startIndex)

To get a suffix of the word starting at the index given in parameter.

Parameters:

startIndex - the starting index

Returns:

the suffix

contains

@API
public boolean contains(boolean b)

To check whether the word contains at least one bit with the value of b.

Parameters:

b - the value to test

Returns:

true if it contains, false otherwise

rotate

@API
public BinaryWord rotate(int indexTowardRight)

To rotate the word toward right. the last bits on the right becomes the first on the left.
For example, 01101100001.rotate(5) gives 00001011011.

Parameters:

indexTowardRight -

Returns:

the rotated binary word

getAlpha

@API
public static int getAlpha(int k,
               int p)

To get the value alpha. alpha is the inverse of (-k) mod p with (k -alpha*k <==> 1 mod p.

Parameters:

k - the periodicity

p - the period

Returns:

alpha

isInferiorTo

@API
public boolean isInferiorTo(BinaryWord word2)

To check whether this is inferior to word2

Parameters:

word2 -

Returns:

compare(word2) == -1;

isSuperiorTo

@API
public boolean isSuperiorTo(BinaryWord word2)

To check whether this is superior to word2

Parameters:

word2 -

Returns:

compare(word2) == 1;

equals

@API
public boolean equals(java.lang.Object word2)

It test whether words is an instance of BinaryWord. then it returns compare((BinaryWord)word2) == 0;

Overrides:

equals in class java.lang.Object

intValue

@API
public int intValue()

Return the value of the word in base 10.

Returns:

the word in base 10

complement

@API
public BinaryWord complement()

To get the complement of the word. "11010".complement() gives "00101".

Returns:

the complement

getTheMinBalancedBinaryWord

@API
public static BinaryWord getTheMinBalancedBinaryWord(int k,
                                         int p)

Generate the minimal balanced binary word of length p containing k true value.

Parameters:

k - the periodicity

p - the period

Returns:

the balanced binary word

getTheMaxBalancedBinaryWord

@API
public static BinaryWord getTheMaxBalancedBinaryWord(int k,
                                         int p)

Generate the maximal balanced binary word of length p containing k true value.

Parameters:

k - the periodicity

p - the period

Returns:

the balanced binary word