permutation.h

Scalable k-means software and test datasets This package (a Unix tar file, gzipped) contains the sou

/* Scalable K-means clustering software
Copyright (C) 2000  Fredrik Farnstrom and James Lewis

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


See the file README.TXT for more information.

*/

/* permutation.h */

#ifndef PERMUTATION_H
#define PERMUTATION_H

#ifndef COMMON_H
#include "common.h"
#endif

class RandomGenerator;

/* The permutation class provides a series of integers 1..n, in
	a random order. */

class Permutation
{
	// Pointer to array of numbers.
	int *numbers;

	// Current number of numbers in the array.
	int currentNumNumbers;

	// Maximum number of numbers in the array.
	int maxNumNumbers;

	RandomGenerator *randomGenerator;
public:
	// Create a new permutation, returning integers 1..num. The permutation
	// can be used immediately, reset() does not have to be called first.
	Permutation(int num);

	Permutation(int num, RandomGenerator *randgen);

	// Destructor.
	virtual ~Permutation();

	// Reset permutation, i.e the next maxNumNumbers calls to
	// getNumber will return integers 1..num in random order.
	void reset(void);

	// Reset permutation and set number of numbers in the permutation.
	void reset(int num);

	// Return next number from the permutation. After maxNumNumbers calls
	// to getNumber(), reset() will be called automatically, and a new
	// sequence of random number will be created.
	int getNumber(void);
};


#endif

/* End of file permutation.h */