ObjectiveLib  1.0.0
Public Member Functions | Static Public Member Functions | Protected Attributes
OLUnaryNegate Class Reference

A unary function object that negates the action of another unary function object. More...

#import <ObjectiveLib/Functional.h>

Inheritance diagram for OLUnaryNegate:
Inheritance graph
[legend]

List of all members.

Public Member Functions

(void) - encodeWithCoder:
 Encode the function object.
(BOOL) - performUnaryFunctionWithArg:
 Perform the underlying function and return the opposite of its result.
(void) - writeSelfToStream:
Initializers and Deallocators
(id) - initWithCoder:
(id) - initWithObjectInStream:
(id) - initWithUnaryFunction:
 Initialize the function object with the function that should be negated.
(void) - dealloc
 Finalize the function object and deallocate any allocated memory.

Static Public Member Functions

(id) + functorWithUnaryFunction:
 Create and return an instance of OLUnaryNegate.

Protected Attributes

OLStreamableFunctor
< OLBoolUnaryFunction > * 
fn
 The underyling unary function that will be negated.

Detailed Description

A unary function object that negates the action of another unary function object.

The action message of this object simple returns the opposite of the target function object.


Member Function Documentation

- (void) dealloc

Finalize the function object and deallocate any allocated memory.

- (void) encodeWithCoder: (NSCoder *)  encoder

Encode the function object.

The function object is saved to an archive using encoder. The function object will be retrieved from the archive using the initializer #initWithCoder:.

Parameters:
encoderthe coder which will save the function object to the archive

Reimplemented from OLStreamableFunctor.

Create and return an instance of OLUnaryNegate.

Note:
If OpenStep is present the returned object will be autoreleased before being returned.
Parameters:
functionthe function that OLUnaryNegate will negate
Returns:
a new functor

Initialize the function object with the function that should be negated.

Parameters:
functionthe target function that will be negated
Returns:
a reference to this function object
- (BOOL) performUnaryFunctionWithArg: (id)  arg

Perform the underlying function and return the opposite of its result.

Parameters:
argthe argument to pass to the target function
Returns:
the opposite of the target function's result

Reimplemented from <OLBoolUnaryFunction>.


Member Data Documentation

The underyling unary function that will be negated.


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

ObjectiveLibGenerated Sat Feb 15 2014 07:45:35, © 2004-2007 Will Mason