OOProbabilitySet Class Reference

#include <OOProbabilitySet.h>

Inheritance diagram for OOProbabilitySet:

Collaboration diagram for OOProbabilitySet:

Instance Methods
(id)	- init
(id)	- initWithObjects:weights:count:
(id)	- initWithPropertyListRepresentation:
(NSDictionary *)	- propertyListRepresentation
(NSUInteger)	- count
(id)	- randomObject
(float)	- weightForObject:
(float)	- sumOfWeights
(NSArray *)	- allObjects
(id)	- initPriv [implementation]
(NSString *)	- descriptionComponents [implementation]
(id)	- copyWithZone: [implementation]
(id)	- mutableCopyWithZone: [implementation]
(BOOL)	- containsObject:
(NSEnumerator *)	- objectEnumerator
(float)	- probabilityForObject:

Class Methods
(id)	+ probabilitySet
(id)	+ probabilitySetWithObjects:weights:count:
(id)	+ probabilitySetWithPropertyListRepresentation:

Detailed Description

Definition at line 41 of file OOProbabilitySet.h.

Method Documentation

allObjects

- (NSArray *) allObjects

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

containsObject:

- (BOOL) containsObject:

(id)

object

Provided by category OOProbabilitySet(OOExtendedProbabilitySet).

Definition at line 121 of file OOProbabilitySet.m.

{
    return [self weightForObject:object] >= 0.0f;
}
 

copyWithZone:

- (id) copyWithZone: (NSZone *) zone

implementation

Reimplemented in OOConcreteMutableProbabilitySet, OOEmptyProbabilitySet, and OOMutableProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    if (zone == [self zone])
    {
        return [self retain];
    }
    else
    {
        return [[OOProbabilitySet allocWithZone:zone] initWithPropertyListRepresentation:[self propertyListRepresentation]];
    }
}
 

count

- (NSUInteger) count

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 121 of file OOProbabilitySet.m.

{
    return [NSString stringWithFormat:@"count=%lu", [self count]];
}
 

init

- (id) init

Reimplemented in OOMutableProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    [self release];
    return [OOEmptyProbabilitySet singleton];
}
 

initPriv

- (id) initPriv

implementation

Reimplemented in OOConcreteMutableProbabilitySet.

Provided by category OOProbabilitySet(OOPrivate).

Definition at line 121 of file OOProbabilitySet.m.

{
    return [super init];
}
 

initWithObjects:weights:count:

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

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, and OOMutableProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    NSZone *zone = [self zone];
    DESTROY(self);
    
    // Zero objects: return empty-set singleton.
    if (count == 0)  return [OOEmptyProbabilitySet singleton];
    
    // If count is not zero and one of the paramters is nil, we've got us a programming error.
    if (objects == NULL || weights == NULL)
    {
        [NSException raise:NSInvalidArgumentException format:@"Attempt to create %@ with non-zero count but nil objects or weights.", @"OOProbabilitySet"];
    }
    
    // Single object: simple one-object set. Expected to be quite common.
    if (count == 1)  return [[OOSingleObjectProbabilitySet allocWithZone:zone] initWithObject:objects[0] weight:weights[0]];
    
    // Otherwise, use general implementation.
    return [[OOConcreteProbabilitySet allocWithZone:zone] initWithObjects:objects weights:weights count:count];
}
 

initWithPropertyListRepresentation:

- (id) initWithPropertyListRepresentation:

(NSDictionary *)

plist

Reimplemented in OOConcreteMutableProbabilitySet, and OOMutableProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    NSArray                 *objects = nil;
    NSArray                 *weights = nil;
    NSUInteger              i = 0, count = 0;
    id                      *rawObjects = NULL;
    float                   *rawWeights = NULL;
    
    objects = [plist oo_arrayForKey:kObjectsKey];
    weights = [plist oo_arrayForKey:kWeightsKey];
    
    // Validate
    if (objects == nil || weights == nil)
    {
        [self release];
        return nil;
    }
    count = [objects count];
    if (count != [weights count])
    {
        [self release];
        return nil;
    }
    
    // Extract contents.
    rawObjects = malloc(sizeof *rawObjects * count);
    rawWeights = malloc(sizeof *rawWeights * count);
    
    if (rawObjects != NULL || rawWeights != NULL)
    {
        // Extract objects.
        [objects getObjects:rawObjects];
        
        // Extract and convert weights.
        for (i = 0; i < count; ++i)
        {
            rawWeights[i] = fmax([weights oo_floatAtIndex:i], 0.0f);
        }
        
        self = [self initWithObjects:rawObjects weights:rawWeights count:count];
    }
    else
    {
        [self release];
        self = nil;
    }
    
    // Clean up.
    free(rawObjects);
    free(rawWeights);
    
    return self;
}
 

mutableCopyWithZone:

- (id) mutableCopyWithZone: (NSZone *) zone

implementation

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    return [[OOMutableProbabilitySet allocWithZone:zone] initWithPropertyListRepresentation:[self propertyListRepresentation]];
}
 

objectEnumerator

- (NSEnumerator *) objectEnumerator

Reimplemented in OOConcreteMutableProbabilitySet, and OOConcreteProbabilitySet.

Provided by category OOProbabilitySet(OOExtendedProbabilitySet).

Definition at line 121 of file OOProbabilitySet.m.

{
    return [[self allObjects] objectEnumerator];
}
 

probabilityForObject:

- (float) probabilityForObject:

(id)

object

Provided by category OOProbabilitySet(OOExtendedProbabilitySet).

Definition at line 121 of file OOProbabilitySet.m.

{
    float weight = [self weightForObject:object];
    if (weight > 0)  weight /= [self sumOfWeights];
    
    return weight;
}
 

probabilitySet

+ (id) probabilitySet

Reimplemented in OOMutableProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    return [[OOEmptyProbabilitySet singleton] autorelease];
}
 

probabilitySetWithObjects:weights:count:

+ (id) probabilitySetWithObjects:		(id *)	objects
weights:		(float *)	weights
count:		(NSUInteger)	count

Definition at line 121 of file OOProbabilitySet.m.

{
    return [[[self alloc] initWithObjects:objects weights:weights count:count] autorelease];
}
 

probabilitySetWithPropertyListRepresentation:

+ (id) probabilitySetWithPropertyListRepresentation:

(NSDictionary *)

plist

Definition at line 121 of file OOProbabilitySet.m.

{
    return [[[self alloc] initWithPropertyListRepresentation:plist] autorelease];
}
 

propertyListRepresentation

- (NSDictionary *) propertyListRepresentation

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

randomObject

- (id) randomObject

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

sumOfWeights

- (float) sumOfWeights

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

weightForObject:

- (float) weightForObject:

(id)

object

Reimplemented in OOConcreteMutableProbabilitySet, OOConcreteProbabilitySet, OOEmptyProbabilitySet, and OOSingleObjectProbabilitySet.

Definition at line 121 of file OOProbabilitySet.m.

{
    ThrowAbstractionViolationException(self);
}
 

---

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

• src/Core/OOProbabilitySet.h
• src/Core/OOProbabilitySet.m