diff options
| -rw-r--r-- | MLKCons.h | 44 |
1 files changed, 44 insertions, 0 deletions
@@ -19,22 +19,66 @@ #import <Foundation/NSArray.h> +/*! @class MLKCons + +@abstract A cons cell. + +@discussion A cons cell (or simply: a cons) is an ordered pair whose first +element is called the car and whose second element is called the cdr of the cons. +Cons cells are mutable by default. + +Note that nil is explicitely allowed as both the car and cdr of a cons cell. In fact, +when representing linked lists using cons cells, nil in the cdr of the last cons cell +is what conventionally marks the end of a list. +*/ @interface MLKCons : NSObject <NSCopying> { id _car; id _cdr; } +/*! @method cons:with: + +@abstract Cons two objects together. + +@param car The car of the new cons cell. +@param cdr The cdr of the new cons cell. +@return A newly allocated cons. +*/ +(MLKCons*) cons:(id)car with:(id)cdr; + + +/*! @method listWithArray: +@abstract Make a linked list of cons cells out of an array. */ +(MLKCons*) listWithArray:(NSArray *)array; +/*! @method initWithCar:cdr: +@abstract Initialise a new cons cell with car and cdr. +*/ -(MLKCons*) initWithCar:(id)car cdr:(id)cdr; +/*! @method car +@abstract The car of the cons cell. +*/ -(id) car; + +/*! @method cdr +@abstract The cdr of the cons cell. +*/ -(id) cdr; + +/*! @method setCar: +@abstract Change the car of the cons cell. +*/ -(void) setCar:(id)value; + +/*! @method setCdr: +@abstract Change the cdr of the cons cell. +*/ -(void) setCdr:(id)value; +/*! @method array +@abstract Return the content of the linked list represented by this cons cell as an array. */ -(NSArray *) array; -(void) appendObject:(id)object; |