Vuo  1.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Macros | Typedefs | Functions
VuoInteger

Description

A signed 64-bit integer.

Macros

#define VuoInteger_SUPPORTS_COMPARISON
 This type has _areEqual() and _isLessThan() functions.
 
#define MIN(a, b)   (((a)<(b))?(a):(b))
 Returns the smaller of a and b.
 
#define MAX(a, b)   (((a)>(b))?(a):(b))
 Returns the larger of a and b.
 

Typedefs

typedef int64_t VuoInteger
 A signed 64-bit integer.
 

Functions

VuoInteger VuoInteger_makeFromJson (json_object *js)
 Decodes the JSON object js, expected to contain a 64-bit integer, to create a new value.
 
json_objectVuoInteger_getJson (const VuoInteger value)
 Encodes value as a JSON object.
 
char * VuoInteger_getSummary (const VuoInteger value)
 Always shows the full value, since it's guaranteed to be pretty short.
 
VuoInteger VuoInteger_min (VuoInteger *terms, unsigned long termsCount)
 Returns the minimum of an array of terms, or 0 if the array is empty.
 
VuoInteger VuoInteger_max (VuoInteger *terms, unsigned long termsCount)
 Returns the maximum of an array of terms, or 0 if the array is empty.
 
VuoInteger VuoInteger_wrap (VuoInteger value, VuoInteger minimum, VuoInteger maximum)
 Returns value if it is within the range of minimum to maximum (inclusive), otherwise a value wrapped with modular arithmetic to be within the range.
 
VuoInteger VuoInteger_random (const VuoInteger minimum, const VuoInteger maximum)
 Returns a pseudorandom value between minimum and maximum, inclusive.
 
void VuoInteger_setRandomState (unsigned short state[3], const VuoInteger seed)
 Initializes state using the lower 48 bits of seed.
 
VuoInteger VuoInteger_randomWithState (unsigned short state[3], const VuoInteger minimum, const VuoInteger maximum)
 Returns a pseudorandom value between minimum and maximum, inclusive.
 
VuoInteger VuoInteger_makeFromHexByte (unsigned char byte)
 If byte is a valid ASCII hex character (0–9, a–f, A–F), returns the equivalent numeric value.
 
static VuoInteger VuoInteger_add (VuoInteger a, VuoInteger b) __attribute__((const ))
 a+b
 
static VuoInteger VuoInteger_subtract (VuoInteger a, VuoInteger b) __attribute__((const ))
 a-b
 
static VuoInteger VuoInteger_multiply (VuoInteger a, VuoInteger b) __attribute__((const ))
 Provided for generic type equivalence with VuoPoints.
 
static VuoInteger VuoInteger_scale (VuoInteger a, VuoInteger b) __attribute__((const ))
 Provided for generic type equivalence with VuoPoints.
 
static VuoInteger VuoInteger_makeNonzero (VuoInteger a) __attribute__((const ))
 If the value is zero, returns 1.
 
static VuoInteger VuoInteger_snap (VuoInteger a, VuoInteger center, VuoInteger snap) __attribute__((const ))
 Returns a snapped value using a center point and snap value.
 
static bool VuoInteger_areEqual (const VuoInteger value1, const VuoInteger value2)
 Returns true if the two values are equal.
 
static bool VuoInteger_isLessThan (const VuoInteger a, const VuoInteger b)
 Returns true if a < b.
 
static VuoInteger VuoInteger_clamp (VuoInteger value, VuoInteger min, VuoInteger max)
 Limits value to values between min and max, inclusive.
 
VuoInteger VuoInteger_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoInteger_getString (const VuoInteger value)
 Automatically generated function.
 
void VuoInteger_retain (VuoInteger value)
 Automatically generated function.
 
void VuoInteger_release (VuoInteger value)
 Automatically generated function.
 

Macro Definition Documentation

#define MAX (   a,
 
)    (((a)>(b))?(a):(b))

Returns the larger of a and b.

#define MIN (   a,
 
)    (((a)<(b))?(a):(b))

Returns the smaller of a and b.

#define VuoInteger_SUPPORTS_COMPARISON

This type has _areEqual() and _isLessThan() functions.

Typedef Documentation

typedef int64_t VuoInteger

A signed 64-bit integer.

Function Documentation

static VuoInteger VuoInteger_add ( VuoInteger  a,
VuoInteger  b 
) const
inlinestatic

a+b

Provided for generic type equivalence with VuoPoints.

static bool VuoInteger_areEqual ( const VuoInteger  value1,
const VuoInteger  value2 
)
inlinestatic

Returns true if the two values are equal.

static VuoInteger VuoInteger_clamp ( VuoInteger  value,
VuoInteger  min,
VuoInteger  max 
)
inlinestatic

Limits value to values between min and max, inclusive.

struct json_object * VuoInteger_getJson ( const VuoInteger  value)
read

Encodes value as a JSON object.

char* VuoInteger_getString ( const VuoInteger  value)

Automatically generated function.

char * VuoInteger_getSummary ( const VuoInteger  value)

Always shows the full value, since it's guaranteed to be pretty short.

static bool VuoInteger_isLessThan ( const VuoInteger  a,
const VuoInteger  b 
)
inlinestatic

Returns true if a < b.

VuoInteger VuoInteger_makeFromHexByte ( unsigned char  byte)

If byte is a valid ASCII hex character (0–9, a–f, A–F), returns the equivalent numeric value.

Otherwise returns 0.

VuoInteger VuoInteger_makeFromJson ( json_object js)

Decodes the JSON object js, expected to contain a 64-bit integer, to create a new value.

VuoInteger VuoInteger_makeFromString ( const char *  str)

Automatically generated function.

static VuoInteger VuoInteger_makeNonzero ( VuoInteger  a) const
inlinestatic

If the value is zero, returns 1.

Otherwise returns the value.

VuoInteger VuoInteger_max ( VuoInteger terms,
unsigned long  termsCount 
)

Returns the maximum of an array of terms, or 0 if the array is empty.

VuoInteger VuoInteger_min ( VuoInteger terms,
unsigned long  termsCount 
)

Returns the minimum of an array of terms, or 0 if the array is empty.

static VuoInteger VuoInteger_multiply ( VuoInteger  a,
VuoInteger  b 
) const
inlinestatic

Provided for generic type equivalence with VuoPoints.

VuoInteger VuoInteger_random ( const VuoInteger  minimum,
const VuoInteger  maximum 
)

Returns a pseudorandom value between minimum and maximum, inclusive.

This function uses arc4random_uniform() (the key stream generator employed by the arc4 cipher). It is self-seeding.

Both maximum and maximum - minimum must be INT_MAX (2^31) or less.

VuoInteger VuoInteger_randomWithState ( unsigned short  state[3],
const VuoInteger  minimum,
const VuoInteger  maximum 
)

Returns a pseudorandom value between minimum and maximum, inclusive.

This function uses jrand48() (a linear congruential algorithm).

Seed it by providing 3 x 16-bit values to state, which is modified upon return. Pass the modified state back to this function to retrieve the next value in the sequence.

Both maximum and maximum - minimum must be INT_MAX (2^31) or less.

void VuoInteger_release ( VuoInteger  value)

Automatically generated function.

void VuoInteger_retain ( VuoInteger  value)

Automatically generated function.

static VuoInteger VuoInteger_scale ( VuoInteger  a,
VuoInteger  b 
) const
inlinestatic

Provided for generic type equivalence with VuoPoints.

void VuoInteger_setRandomState ( unsigned short  state[3],
const VuoInteger  seed 
)

Initializes state using the lower 48 bits of seed.

static VuoInteger VuoInteger_snap ( VuoInteger  a,
VuoInteger  center,
VuoInteger  snap 
) const
inlinestatic

Returns a snapped value using a center point and snap value.

static VuoInteger VuoInteger_subtract ( VuoInteger  a,
VuoInteger  b 
) const
inlinestatic

a-b

Provided for generic type equivalence with VuoPoints.

VuoInteger VuoInteger_wrap ( VuoInteger  value,
VuoInteger  minimum,
VuoInteger  maximum 
)

Returns value if it is within the range of minimum to maximum (inclusive), otherwise a value wrapped with modular arithmetic to be within the range.