OOConcreteMutableProbabilitySet Class Reference

Inheritance diagram for OOConcreteMutableProbabilitySet:

Collaboration diagram for OOConcreteMutableProbabilitySet:

Instance Methods
(id)	- initPrivWithObjectArray:weightsArray:sum:
(id)	- initPriv [implementation]
(id)	- initWithObjects:weights:count: [implementation]
(id)	- initWithPropertyListRepresentation: [implementation]
(void)	- dealloc [implementation]
(NSDictionary *)	- propertyListRepresentation [implementation]
(NSUInteger)	- count [implementation]
(id)	- randomObject [implementation]
(float)	- weightForObject: [implementation]
(float)	- sumOfWeights [implementation]
(NSArray *)	- allObjects [implementation]
(NSEnumerator *)	- objectEnumerator [implementation]
(void)	- setWeight:forObject: [implementation]
(void)	- removeObject: [implementation]
(id)	- copyWithZone: [implementation]
(id)	- mutableCopyWithZone: [implementation]
Instance Methods inherited from OOMutableProbabilitySet
(id)	- init [implementation]
Instance Methods inherited from OOProbabilitySet
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- containsObject:
(float)	- probabilityForObject:

Private Attributes
NSMutableArray *	_objects
NSMutableArray *	_weights
float	_sumOfWeights

Additional Inherited Members
Class Methods inherited from OOMutableProbabilitySet
(id)	+ probabilitySet [implementation]
Class Methods inherited from OOProbabilitySet
(id)	+ probabilitySetWithObjects:weights:count:
(id)	+ probabilitySetWithPropertyListRepresentation:

Detailed Description

Definition at line 104 of file OOProbabilitySet.m.

Method Documentation

allObjects

- (NSArray *) allObjects

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    return [[_objects copy] autorelease];
}
 

copyWithZone:

- (id) copyWithZone: (NSZone *) zone

implementation

Reimplemented from OOMutableProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    id                      result = nil;
    id                      *objects = NULL;
    float                   *weights = NULL;
    NSUInteger              i = 0, count = 0;
    
    count = [_objects count];
    if (EXPECT_NOT(count == 0))  return [OOEmptyProbabilitySet singleton];
    
    objects = malloc(sizeof *objects * count);
    weights = malloc(sizeof *weights * count);
    if (objects != NULL && weights != NULL)
    {
        [_objects getObjects:objects];
        
        for (i = 0; i < count; ++i)
        {
            weights[i] = [_weights oo_floatAtIndex:i];
        }
        
        result = [[OOProbabilitySet probabilitySetWithObjects:objects weights:weights count:count] retain];
    }
    
    if (objects != NULL)  free(objects);
    if (weights != NULL)  free(weights);
    
    return result;
}
 

count

- (NSUInteger) count

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    return [_objects count];
}
 

dealloc

- (void) dealloc

implementation

Definition at line 458 of file OOProbabilitySet.m.

{
    [_objects release];
    [_weights release];
    
    [super dealloc];
}
 

initPriv

- (id) initPriv

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    if ((self = [super initPriv]))
    {
        _objects = [[NSMutableArray alloc] init];
        _weights = [[NSMutableArray alloc] init];
    }
    
    return self;
}
 

initPrivWithObjectArray:weightsArray:sum:

- (id) initPrivWithObjectArray:		(NSMutableArray *)	objects
weightsArray:		(NSMutableArray *)	weights
sum:		(float)	sumOfWeights

Definition at line 458 of file OOProbabilitySet.m.

{
    assert(objects != nil && weights != nil && [objects count] == [weights count] && sumOfWeights >= 0.0f);
    
    if ((self = [super initPriv]))
    {
        _objects = [objects retain];
        _weights = [weights retain];
        _sumOfWeights = sumOfWeights;
    }
    
    return self;
}
 

initWithObjects:weights:count:

- (id) initWithObjects: (id *) objects weights: (float *) weights count: (NSUInteger) count

implementation

Reimplemented from OOMutableProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    NSUInteger              i = 0;
    
    // Validate parameters.
    if (count != 0 && (objects == NULL || weights == NULL))
    {
        [self release];
        [NSException raise:NSInvalidArgumentException format:@"Attempt to create %@ with non-zero count but nil objects or weights.", @"OOMutableProbabilitySet"];
    }
    
    // Set up & go.
    if ((self = [self initPriv]))
    {
        for (i = 0; i != count; ++i)
        {
            [self setWeight:fmax(weights[i], 0.0f) forObject:objects[i]];
        }
    }
    
    return self;
}
 

initWithPropertyListRepresentation:

- (id) initWithPropertyListRepresentation: (NSDictionary *) plist

implementation

Reimplemented from OOMutableProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    BOOL                    OK = YES;
    NSArray                 *objects = nil;
    NSArray                 *weights = nil;
    NSUInteger              i = 0, count = 0;
    
    if (!(self = [super initPriv]))  OK = NO;
    
    if (OK)
    {
        objects = [plist oo_arrayForKey:kObjectsKey];
        weights = [plist oo_arrayForKey:kWeightsKey];
        
        // Validate
        if (objects == nil || weights == nil)  OK = NO;
        count = [objects count];
        if (count != [weights count])  OK = NO;
    }
    
    if (OK)
    {
        for (i = 0; i < count; ++i)
        {
            [self setWeight:[weights oo_floatAtIndex:i] forObject:[objects objectAtIndex:i]];
        }
    }
    
    if (!OK)
    {
        [self release];
        self = nil;
    }
    
    return self;
}
 

mutableCopyWithZone:

- (id) mutableCopyWithZone: (NSZone *) zone

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    return [[OOConcreteMutableProbabilitySet alloc] initPrivWithObjectArray:[[_objects mutableCopyWithZone:zone] autorelease]
                                                               weightsArray:[[_weights mutableCopyWithZone:zone] autorelease]
                                                                        sum:_sumOfWeights];
}
 

objectEnumerator

- (NSEnumerator *) objectEnumerator

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    return [_objects objectEnumerator];
}
 

propertyListRepresentation

- (NSDictionary *) propertyListRepresentation

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    return [NSDictionary dictionaryWithObjectsAndKeys:
            _objects, kObjectsKey,
            _weights, kWeightsKey,
            nil];
}
 

randomObject

- (id) randomObject

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    float                   target = 0.0f, sum = 0.0f, sumOfWeights;
    NSUInteger              i = 0, count = 0;
    
    sumOfWeights = [self sumOfWeights];
    target = randf() * sumOfWeights;
    count = [_objects count];
    if (count == 0 || sumOfWeights <= 0.0f)  return nil;
    
    for (i = 0; i < count; ++i)
    {
        sum += [_weights oo_floatAtIndex:i];
        if (sum >= target)  return [_objects objectAtIndex:i];
    }
    
    OOLog(@"probabilitySet.broken", @"%s fell off end, returning first object. Nominal sum = %f, target = %f, actual sum = %f, count = %lu. %@", __PRETTY_FUNCTION__, sumOfWeights, target, sum, count,@"This is an internal error, please report it.");
    return [_objects objectAtIndex:0];
}
 

removeObject:

- (void) removeObject: (id) object

implementation

Reimplemented from OOMutableProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    if (object == nil)  return;
    
    NSUInteger index = [_objects indexOfObject:object];
    if (index != NSNotFound)
    {
        [_objects removeObjectAtIndex:index];
        _sumOfWeights = -1.0f;  // Simply subtracting the relevant weight doesn't work if the weight is large, due to floating-point precision issues.
        [_weights removeObjectAtIndex:index];
    }
}
 

setWeight:forObject:

- (void) setWeight: (float) weight forObject: (id) object

implementation

Reimplemented from OOMutableProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    if (object == nil)  return;
    
    weight = fmax(weight, 0.0f);
    NSUInteger index = [_objects indexOfObject:object];
    if (index == NSNotFound)
    {
        [_objects addObject:object];
        [_weights oo_addFloat:weight];
        if (_sumOfWeights >= 0)
        {
            _sumOfWeights += weight;
        }
        // Else, _sumOfWeights is invalid and will need to be recalculated on demand.
    }
    else
    {
        _sumOfWeights = -1.0f;  // Simply subtracting the relevant weight doesn't work if the weight is large, due to floating-point precision issues.
        [_weights replaceObjectAtIndex:index withObject:[NSNumber numberWithFloat:weight]];
    }
}
 

sumOfWeights

- (float) sumOfWeights

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    if (_sumOfWeights < 0.0f)
    {
        NSUInteger          i, count;
        count = [self count];
        
        _sumOfWeights = 0.0f;
        for (i = 0; i < count; ++i)
        {
            _sumOfWeights += [_weights oo_floatAtIndex:i];
        }
    }
    return _sumOfWeights;
}
 

weightForObject:

- (float) weightForObject: (id) object

implementation

Reimplemented from OOProbabilitySet.

Definition at line 458 of file OOProbabilitySet.m.

{
    float                   result = -1.0f;
    
    if (object != nil)
    {
        NSUInteger index = [_objects indexOfObject:object];
        if (index != NSNotFound)
        {
            result = [_weights oo_floatAtIndex:index];
            if (index != 0)  result -= [_weights oo_floatAtIndex:index - 1];
        }
    }
    return result;
}
 

Member Data Documentation

_objects

- (NSMutableArray*) _objects

private

Definition at line 107 of file OOProbabilitySet.m.

_sumOfWeights

- (float) _sumOfWeights

private

Definition at line 109 of file OOProbabilitySet.m.

_weights

- (NSMutableArray*) _weights

private

Definition at line 108 of file OOProbabilitySet.m.

---

The documentation for this class was generated from the following file:

• src/Core/OOProbabilitySet.m