org.expasy.mzjava.utils

Class MixedRadixNtupleGenerator

java.lang.Object

org.expasy.mzjava.utils.MixedRadixNtupleGenerator

public class MixedRadixNtupleGenerator
extends Object

This object generates all tuples of length n (n-tuple) where each element belongs to different base numbers bi. As an example, from the mixed radix triplet [2,3,2] we can generate 12 permutations of triplets from [000] to [121]. [Donald Knuth - The Art of Computer Programming Volume 4, Fascicle 2: Generating All tuples and permutations, (Addison-Wesley, February 14, 2005) v+127pp, ISBN 0-201-85393-0, section 7.1.1 : Algorithm M]

Author:

fnikitin Date: 11/1/13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MixedRadixNtupleGenerator.Handler
static class	MixedRadixNtupleGenerator.NtupleContainer A reusable container that stores generated n-tuples

Constructor Summary

Constructors

Constructor and Description
MixedRadixNtupleGenerator(MixedRadixNtupleGenerator.Handler handler)

Method Summary

Methods

Modifier and Type	Method and Description
static long	countNtuples(int[] radices) Compute the number of n-tuples given the radices.
void	generate(int[] radices) This algorithm generates all n-tuples with different radices and give them to the Handler [from knuth the AOCP, section 7.1.1 : Algorithm M]
void	generate(int n, int radix) This algorithm generate all n-tuples with the same radix at any positions.
static String	toString(List<int[]> ntuples) A simple string converter for n-tuples.

Methods inherited from class java.lang.Object

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

Constructor Detail

MixedRadixNtupleGenerator

public MixedRadixNtupleGenerator(MixedRadixNtupleGenerator.Handler handler)

Parameters:

handler - provides the callback method that have to handle n-tuple

Method Detail

generate

public void generate(int n,
            int radix)

This algorithm generate all n-tuples with the same radix at any positions.

Parameters:

n - the tuple length.

radix - the radix for each digit.

generate

public void generate(int[] radices)

This algorithm generates all n-tuples with different radices and give them to the Handler [from knuth the AOCP, section 7.1.1 : Algorithm M]

Parameters:

radices - the number bases [b0, ..., bn] such as ai in [0, bi[.

countNtuples

public static long countNtuples(int[] radices)

Compute the number of n-tuples given the radices.

Parameters:

radices - the radices by position.

Returns:

the total number of n-tuples.

toString

public static String toString(List<int[]> ntuples)

A simple string converter for n-tuples.

Parameters:

ntuples - the n-tuples to convert.

Returns:

a string representation of n-tuples.