Number Struct Reference

#include <Number.h>

Overview

A wrapper for placing numeric primitives into collections, etc.

Definition at line 41 of file Number.h.

Inheritance diagram for Number:

Properties
Object	object
	The superclass. More...
double	value
	The backing value. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_Number (void)
	The Number archetype. More...
_Bool	boolValue (const Number *self)
char	charValue (const Number *self)
Order	compareTo (const Number *self, const Number *other)
	Compares this Number to another. More...
double	doubleValue (const Number *self)
float	floatValue (const Number *self)
Number *	initWithValue (Number *self, double value)
	Initializes this Number with the specified value. More...
int	intValue (const Number *self)
long	longValue (const Number *self)
Number *	numberWithValue (double value)
	Returns a new Number with the given value. More...
short	shortValue (const Number *self)
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
NumberInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

interface

NumberInterface* Number::interface

protected

The interface.

Definition at line 52 of file Number.h.

object

Object Number::object

The superclass.

Definition at line 46 of file Number.h.

value

double Number::value

The backing value.

Definition at line 57 of file Number.h.

Method Details

_Number()

Class * _Number

(

void

)

The Number archetype.

Returns

The Number Class.

Definition at line 198 of file Number.c.

                     {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Number",
            .superclass = _Object(),
            .instanceSize = sizeof(Number),
            .interfaceOffset = offsetof(Number, interface),
            .interfaceSize = sizeof(NumberInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

boolValue()

_Bool boolValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's _Bool value.

Definition at line 80 of file Number.c.

                                           {
    return self->value ? true : false;
}

charValue()

char charValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's char value.

Definition at line 88 of file Number.c.

                                          {
    return (char) self->value;
}

compareTo()

Order compareTo	(	const Number *	self,
		const Number *	other
	)

Compares this Number to another.

Parameters

self	The Number.
other	The Number to compare to.

Returns

The ordering of this Number compared to other.

Definition at line 96 of file Number.c.

                                                                {
 
    if (other) {
        if (self->value == other->value) {
            return OrderSame;
        }
 
        return self->value < other->value ? OrderAscending : OrderDescending;
    }
 
    return OrderAscending;
}

doubleValue()

double doubleValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's double value.

Definition at line 113 of file Number.c.

                                              {
    return self->value;
}

floatValue()

float floatValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's floating point value.

Definition at line 121 of file Number.c.

                                            {
    return (float) self->value;
}

initWithValue()

Number * initWithValue	(	Number *	self,
		double	value
	)

Initializes this Number with the specified value.

Parameters

self	The Number.
value	The value.

Returns

The initialized Number, or NULL on error.

Definition at line 137 of file Number.c.

                                                               {
 
    self = (Number *) super(Object, self, init);
    if (self) {
        self->value = value;
    }
 
    return self;
}

intValue()

int intValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's integer value.

Definition at line 151 of file Number.c.

                                        {
    return (int) self->value;
}

longValue()

long longValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's long value.

Definition at line 129 of file Number.c.

                                          {
    return (long) self->value;
}

numberWithValue()

Number * numberWithValue

(

double

value

)

Returns a new Number with the given value.

Parameters

value

The value.

Returns

The new Number, or NULL on error.

Definition at line 159 of file Number.c.

                                             {
    return $(alloc(Number), initWithValue, value);
}

shortValue()

short shortValue

(

const Number *

self

)

Parameters

self	The Number.

Returns

This Number's short value.

Definition at line 167 of file Number.c.

                                            {
    return (short) self->value;
}

---

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

• Sources/Objectively/Number.h
• Sources/Objectively/Number.c