Skip to content

Commit

Permalink
[DAZABTest.h] Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dasmer Singh committed Nov 12, 2014
1 parent e91c1e5 commit c52f71f
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion DAZABTest/DAZABTest.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,31 @@

@interface DAZABTest : NSObject

/**
Run a split test in which the user is randomly assigned to one of the specified values with equal probability.
@param name A unique identifier for the test.
@param values The possible results a user can be assigned to.
@return The result of the split test with the given name.
*/
+ (id)splitTestWithName:(NSString *)name values:(NSArray *)values;

/**
Run a split test in which the user is randomly assigned to one of the conditions with the specified probabilities.
@param name A unique identifier for the test.
@param conditions The keys are the possible results for the user to be assigned to and the values are the weighted probabilities of each result set as an `NSNumber`.
@return The result of the split test with the given name.
*/
+ (id)splitTestWithName:(NSString *)name conditions:(NSDictionary *)conditions;

/**
Reset a particular test, by clearing any previous assignments for the user.
@param name A unique identifier for the test.
*/
+ (void)resetSplitTestWithName:(NSString *)name;

@end
@end

0 comments on commit c52f71f

Please sign in to comment.