GeniusAssociationEnumerator.h

/*
	Genius
	Copyright (C) 2003-2006 John R Chang
	Copyright (C) 2007-2008 Chris Miner

	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.	

	http://www.gnu.org/licenses/gpl.txt
*/

#import <Foundation/Foundation.h>

@class GeniusAssociation;

@interface GeniusAssociationEnumerator : NSObject {
    NSMutableArray * _inputAssociations;  //!< GeniusAssociation items to filter.
    
    unsigned int _count;                  //!< Minium number of items to return.
    int _minimumScore;                    //!< Score cutoff for returned items.
    float _m_value;                       //!< Center value for the probability based selection.

    // Transient state
    int _maximumScore;                    //!< Temporary value used in probability based selection.
    
    NSMutableArray * _scheduledAssociations;  //!< The selection of items returned via nextAssociation.
    BOOL _hasPerformedChooseAssociations;     //!< Flag indicating if performChooseAssociations has been called.
}

- (id) initWithAssociations:(NSArray *)associations;

// This stuff doesn't really belong in this class
- (void) setCount:(unsigned int)count;
- (void) setMinimumScore:(int)score;
- (void) setProbabilityCenter:(float)value;
- (void) performChooseAssociations;

- (int) remainingCount;

- (GeniusAssociation *) nextAssociation;

- (void) associationRight:(GeniusAssociation *)association;
- (void) associationWrong:(GeniusAssociation *)association;
- (void) associationSkip:(GeniusAssociation *)association;

@end