Type

This class is used to map Ruby objects on native datatypes and to do element-type coercions for native datatypes.

Summary

Type	This class is used to map Ruby objects on native datatypes and to do element-type coercions for native datatypes.
Functions
Type.inspect	Same as Type.to_s.
Type.to_s	Display name of this type.
Type.to_str	Same as Type.to_s.
Type._load	Marshalling support.
Type.element_type	Used internally.
Type.num_elements	Used internally.
Type.alloc	Allocate required memory for this type.
Type.empty?	Check whether this is an empty array.
Type.dimension	Returns number of dimensions for arrays or 0.
Type.stride	Returns stride of array or nil.
Type.contiguous?	Used internally.
Type.contiguous	Used internally to get corresponding type with contiguous memory-layout.
Type.strides	Returns array of strides for arrays or [].
Type.shape	Returns array of dimensions for arrays or [].
Type.size	Recursively compute number of elements.
Type.check_size	Used internally to check for correct size of arguments.
Type.check_shape	Used internally to check for correct shape of arguments.
Type.check_filter	Used internally to check for correct shape of filter for correlation.
Type.layout	Used internally to describe memory-layout of this type.
Type.contiguous?	Returns true if the memory-layout of this type is contiguous.
Type.indgen	Allocate new instance and fill with index array.
Type.typecode	Recursively get element-type for multi-dimensional arrays or return itself.
Type.basetype	Recursively get basic type for multi-dimensional arrays and composite numbers or return itself.
Type.rgb?	Used internally.
Type.bool	Used internally.
Type.float	Used internally.
Type.scalar	Used internally.
Type.floatscalar	Used internally.
Type.maxint	Used internally.
Type.byte	Used internally.
Type.to_type	Used internally.
Type.decompose	Decompose composite numbers, i.e.
Type.boolean	Used internally.
Type.byteval	Used internally.
Type.largeint	Used internally.
Type.floating	Used internally.
Type.fit	Used internally.
Type.match	Used internally.
Type.align	Used internally.
Type.cache	Used internally for caching JIT-methods.
Type.coerce	Used internally.
Type.coercion	Used internally for balancing native types.
Type.===	Test on identity.
to_s	Convert data to string.
export	Convert data to string.
to_str	Same as to_s.
coerce	Used internally.
_dump	Marshalling support.
element_type	Used internally.
num_elements	Used internally.
typecode	Get type of elements.
typesize	Storage size of type (number of bytes for native types, number of Ruby objects otherwise)
size	Overall number of elements in array or 1 if this is not an array.
empty?	Returns a boolean indicating whether this is an empty array.
stride	Used internally to get array stride.
layout	Used internally to describe memory-layout of this type.
contiguous?	Used internally.
contiguous	Used internally to get corresponding type with contiguous memory-layout.
dimension	Get number of dimensions of this array or 0 if this is not an array.
shape	Get array with dimensions of this array or [] if this is not an array.
strides	Used internally.
width	Get width of array.
height	Get height of array.
basetype	Used internally.
rgb?	Used internally.
check_size	Used internally to check for correct size of arguments.
check_shape	Used internally to check for correct shape of arguments.
check_filter	Used internally to check for correct shape of filter for correlation.
memory	Used internally.
to_type	Element-wise conversion to a different type.
typecast	Used internally to typecast native data.
reshape	Create array with same data but different shape.
decompose	Decompose composite numbers, i.e.
set	Used internally to set content of this object to specified value.
get	Used internally to get content of this object.
sel	Get single elements or a region of this array.
at	Get single elements or a region of this array.
[]	Get single elements or a region of this array.
assign	Assign new values to elements.
[]=	Assign value to an element or to a region of the array.
==	Test on equality.
fill!	Overwrite value or fill with value if this is an array.
each	Iterator to iterate over all elements.
multi_each	Iterator mechanism for iterating over multiple arrays at the same time.
collect	Apply function to each element and return result.
collect!	Apply function to each element and replace elements with result.
multi_collect	Iterator mechanism for iterating over multiple arrays at the same time.
op	Used internally to perform element-wise operations (map operations).
op_	Used internally to perform element-wise operations (map operations).
inject	Similar to Array::inject.
inject_	Used internally to perform injections (reduce operations).
indgen!	Fill with index values.
random!	Fill with random numbers.
swap_rgb	Swap red and blue channel.
conditional	Select elements from a or b depending whether this value is true or false.
map	Apply element-wise look-up to array.
hist	Compute histogram of the array.
hist_weighted	Compute weighted histogram of the array.
muladd	Used internally to perform correlations.
muladd_	Used internally to perform correlations.
correlate	Optimized n-dimensional correlation for small filters.
integral	Compute integral of n-dimensional array.
integrate	Used internally.
knot	Used internally.
integrate_	Used internally.
divergence	Compute divergence of n-dimensional array.
zip	Converts the elements of self and each argument to arrays and concatenates them.
real	Get real part of complex number(s).
real=	Set real part of complex number(s).
imag	Get imaginary part of complex number(s).
imag=	Set imaginary part of complex numbers(s).
r	Get red channel.
r=	Set red channel.
g	Get green channel.
g=	Set green channel.
b	Get blue channel.
b=	Set blue channel.
zero?	Compare with zero.
zero?	Compare with zero.
-@	Compute additive inverse.
+@	Does nothing.
abs	Compute absolute value.
arg	Compute complex argument.
conj	Compute complex conjugate.
floor	Round to largest integer not greater than this value.
ceil	Round to smallest integer not smaller than this value.
not	Compute boolean “not”.
~	Compute bitwise “not”.
round	Round to nearest integer.
and	Boolean “and”.
or	Boolean “or”.
&	Bitwise “and”.
\|	Bitwise “or”.
^	Bitwise “xor”.
<<	Shift bits to the left.
>>	Shift bits to the right.
<=>	Comparison operator.
+	Addition.
-	Subtraction.
*	Multiplication.
/	Division.
%	Remainder.
**	Power.
<	Lower-than comparison.
<=	Lower-than-or-equal-to comparison.
>	Greater-than comparison.
>=	Greater-than-or-equal-to comparison.
eq	Equal-to comparison.
ne	Not-equal-to comparison.
ge	Same as >=
gt	Same as >
le	Same as <=
lt	Same as <
major	Choose larger value of two.
minor	Choose smaller value of two.

Functions

Type.inspect

def Type.inspect

Same as Type.to_s.

Type.to_s

def Type.to_s

Display name of this type.

Type.to_str

def Type.to_str

Same as Type.to_s.

Type._load

def Type._load( str )

Marshalling support.

Type.element_type

def Type.element_type

Used internally. Returns type of element for arrays or itself.

Type.num_elements

def Type.num_elements

Used internally. Returns number of elements for arrays or 1.

Type.alloc

def Type.alloc( n = 1 )

Allocate required memory for this type.

Parameters

n	Number of instances required (optional)

Type.empty?

def Type.empty?

Check whether this is an empty array.

Returns

true if num_elements is zero

Type.dimension

def Type.dimension

Returns number of dimensions for arrays or 0.

Type.stride

def Type.stride

Returns stride of array or nil.

Type.contiguous?

def Type.contiguous?

Used internally. Returns true if the data is stored contiguously.

Type.contiguous

def Type.contiguous

Used internally to get corresponding type with contiguous memory-layout.

Type.strides

def Type.strides

Returns array of strides for arrays or [].

Type.shape

def Type.shape

Returns array of dimensions for arrays or [].

Type.size

def Type.size

Recursively compute number of elements.

Type.check_size

def Type.check_size( * args )

Used internally to check for correct size of arguments.

Type.check_shape

def Type.check_shape( * args )

Used internally to check for correct shape of arguments.

Type.check_filter

def Type.check_filter( filter )

Used internally to check for correct shape of filter for correlation.

Type.layout

def Type.layout

Used internally to describe memory-layout of this type.

Type.contiguous?

def Type.contiguous?

Returns true if the memory-layout of this type is contiguous.

Type.indgen

def Type.indgen( offset = 0,
increment = 1 )

Allocate new instance and fill with index array. Use indgen! instead.

Type.typecode

def Type.typecode

Recursively get element-type for multi-dimensional arrays or return itself.

Type.basetype

def Type.basetype

Recursively get basic type for multi-dimensional arrays and composite numbers or return itself.

Type.rgb?

def Type.rgb?

Used internally. Returns true if the element-type is an RGB-type.

Type.bool

def Type.bool

Used internally. Get corresponding array type with boolean elements.

Type.float

def Type.float

Used internally. Get corresponding array type with floating-point values.

Type.scalar

def Type.scalar

Used internally. Get corresponding array type with element-type of composite numbers.

Type.floatscalar

def Type.floatscalar

Used internally. Same as ‘scalar.float’.

Type.maxint

def Type.maxint

Used internally. Get corresponding array type with 32-bit integers.

Type.byte

def Type.byte

Used internally. Get corresponding array type with 8-bit integers.

Type.to_type

def Type.to_type( typecode,
options = {} )

Used internally. Get corresponding array type with other element-type.

Type.decompose

def Type.decompose

Decompose composite numbers, i.e. typecast them to arrays.

Type.boolean

def Type.boolean( other )

Used internally. Same as ‘coercion( other ).bool’.

Type.byteval

def Type.byteval( other )

Used internally. Same as ‘coercion( other ).byte’.

Type.largeint

def Type.largeint( other )

Used internally. Same as ‘coercion( other ).maxint’.

Type.floating

def Type.floating( other )

Used internally. Same as ‘coercion( other ).float’.

Type.fit

def Type.fit( * values )

Used internally. Find type which matches a set of Ruby values.

Parameters

values

set of Ruby values to find native type for

Type.match

def Type.match( value,
context = nil )

Used internally. Find type which matches a Ruby value. Align the resulting type depending on the context (e.g. prefer single-precision floating-point if the context is SFLOAT).

Parameters

value	Ruby value to find native type for
context	Preferred type (optional)

Type.align

def Type.align( context )

Used internally. Align type depending on context.

Type.cache

def Type.cache( descriptor,
* hash )

Used internally for caching JIT-methods.

Type.coerce

def Type.coerce( other )

Used internally. Implementation of Ruby’s coercion mechanism.

Type.coercion

def Type.coercion( other )

Used internally for balancing native types.

Type.===

def Type.===( other )

Test on identity.

to_s

def to_s

Convert data to string.

export

def export

Convert data to string. If data consists of Ruby objects, return an array of Ruby objects instead.

to_str

def to_str

Same as to_s.

coerce

def coerce( other )

Used internally. Implementation of Ruby’s coercion mechanism.

_dump

def _dump( depth )

Marshalling support.

element_type

def element_type

Used internally. Returns type of element for arrays or itself.

num_elements

def num_elements

Used internally. Returns number of elements for arrays or 1.

typecode

def typecode

Get type of elements.

typesize

def typesize

Storage size of type (number of bytes for native types, number of Ruby objects otherwise)

size

def size

Overall number of elements in array or 1 if this is not an array.

empty?

def empty?

Returns a boolean indicating whether this is an empty array.

stride

def stride

Used internally to get array stride.

layout

def layout

Used internally to describe memory-layout of this type.

contiguous?

def contiguous?

Used internally. Returns true if the data is stored contiguously.

contiguous

def contiguous

Used internally to get corresponding type with contiguous memory-layout.

dimension

def dimension

Get number of dimensions of this array or 0 if this is not an array.

shape

def shape

Get array with dimensions of this array or [] if this is not an array.

strides

def strides

Used internally. Returns array of strides for arrays or [].

width

def width

Get width of array. Same as

shape[ 0 ]

height

def height

Get height of array. Same as

shape[ 1 ]

basetype

def basetype

Used internally. Returns basic type if this is a composite type. Otherwise the type itself is returned.

rgb?

def rgb?

Used internally. Returns true if the element-type is an RGB-type.

check_size

def check_size( * args )

Used internally to check for correct size of arguments.

check_shape

def check_shape( * args )

Used internally to check for correct shape of arguments.

check_filter

def check_filter( filter )

Used internally to check for correct shape of filter for correlation.

memory

def memory

Used internally. Returns the memory object which is used to store the data of instance.

to_type

def to_type( type )

Element-wise conversion to a different type. Note that the data is only copied if necessary. If possible a typecast is used instead.

typecast

def typecast( target,
* shape )

Used internally to typecast native data. The target of the typecast must have the same memory size and the layout of the memory must match.

Parameters

target	Resulting type of casted data
shape	Shape of an array (optional)

reshape

def reshape( * shape )

Create array with same data but different shape.

decompose

def decompose

Decompose composite numbers, i.e. typecast them to arrays.

set

def set( value = typecode.default )

Used internally to set content of this object to specified value.

Parameters

value

Ruby object, Ruby array, or object of class Sequence_

get

def get

Used internally to get content of this object.

Returns

Ruby object or object of class Sequence_

sel

def sel( * indices )

Get single elements or a region of this array. Use []- or []=-operator instead.

at

def at( * indices )

Get single elements or a region of this array. Use []-operator instead.

[]

def []( * indices )

Get single elements or a region of this array.

Parameters

indices

Integer-values and/or -ranges.

assign

def assign( * args )

Assign new values to elements. Use []=-operator instead.

[]=

def []=( * args )

Assign value to an element or to a region of the array. It is also possible to multi-dimensional assignments by specifying multiple indices and ranges.

Parameters

args	integer-values and/or -ranges, last argument is the new value of the array element

==

def ==( other )

Test on equality.

fill!

def fill!( value = typecode.default )

Overwrite value or fill with value if this is an array.

each

def each

Iterator to iterate over all elements. Requires a code-block as argument.

multi_each

def multi_each( * args )

Iterator mechanism for iterating over multiple arrays at the same time. You need to specify a block of code accepting an element of each array as parameter.

Parameters

args	Other array objects(s)

collect

def collect( target = typecode )

Apply function to each element and return result. Requires a code block with the function to apply.

Parameters

target

element type of resulting array (optional)

Returns

Array with results.

collect!

def collect!

Apply function to each element and replace elements with result. Requires a code block with the function to apply.

multi_collect

def multi_collect( type,
* args )

Iterator mechanism for iterating over multiple arrays at the same time. You need to specify a block of code accepting an element of each array as parameter.

Parameters

type	Element type of resulting array (optional)
args	the other array(s)

Returns

Array with return values.

op

def op( * args )

Used internally to perform element-wise operations (map operations). Requires a code block with the operation to perform.

Parameters

args	Other arguments involved in the operation.

op_

def op_( * args )

Used internally to perform element-wise operations (map operations). Requires a code block with the operation to perform.

Parameters

args	Other arguments involved in the operation.

inject

def inject( * args )

Similar to Array::inject. Requires a code block with the function to apply.

Parameters

args	initial value for first iteration (optional) and further arguments to be iterated over.

inject_

def inject_( * args )

Used internally to perform injections (reduce operations).

Parameters

args	Initial value for injection followed by secondary arguments (both optional)

indgen!

def indgen!( offset = 0,
increment = 1 )

Fill with index values.

Parameters

offset	value for first element.
increment	increment for the next element.

random!

def random!( n = 1 )

Fill with random numbers. Random numbers are uniformly distributed and will be between 0 and n (excluding n in the case of integers).

Parameters

swap_rgb

def swap_rgb

Swap red and blue channel.

conditional

def conditional( a,
b )

Select elements from a or b depending whether this value is true or false.

Parameteres

a	Return value if this mask is true
b	Return value if this mask is false

map

def map( lut,
options = { :safe => true } )

Apply element-wise look-up to array. The elements of the look-up table can be arrays as well.

Parameters

lut	Array containing look-up table.
safe	Do range checks to avoid segmentation fault

Returns

Array with result of look-up.

hist

def hist( size,
options = { :target => UINT, :safe => true } )

Compute histogram of the array. Note that the size of the histogram must be sufficient to avoid a memory access violation.

Parameters

size	Size of histogram
target	Element-type of new histogram
safe	Do range checks to avoid segmentation fault

Returns

Sequence object containing the histogram.

hist_weighted

def hist_weighted( size,
weights,
options = { :safe => true } )

Compute weighted histogram of the array. Note that the size of the histogram must be sufficient to avoid a memory access violation.

Parameters

size	Size of histogram
weights	Weights for individual samples
safe	Do range checks to avoid segmentation fault

Returns

Sequence object containing the weighted histogram.

muladd

def muladd

Used internally to perform correlations.

muladd_

def muladd_

Used internally to perform correlations.

correlate

def correlate( filter )

Optimized n-dimensional correlation for small filters. The correlation is computed directly and is suitable for small filters. Correlation with elements of type OBJECT is supported as well, but it is very slow. The output object will have the same shape as this object. The boundaries are dealt with by assuming out-of-boundary elements to be zero.

The filter needs to be of type Type and the dimension should be the same as the dimension of this object.

Note that if the filter is separable you should use the separated filters instead to achieve higher performance.

integral

def integral

Compute integral of n-dimensional array. Computes the integral image which is also known as the summed area table. Each element of the resulting array contains the sum of the elements of the input array which do not have any index bigger than the index of the resulting element.

integrate

def integrate( other )

Used internally. Call integral instead.

knot

def knot( arr,
args,
comp,
labels,
rank,
default,
options = {} )

Used internally. Call Sequence_.components instead.

integrate_

def integrate_( other )

Used internally. Call integral instead.

divergence

def divergence

Compute divergence of n-dimensional array. This method is the inverse function of the integral method.

zip

def zip( * arrs )

Converts the elements of self and each argument to arrays and concatenates them. Similar to Array#zip, which is part of the Ruby core.

real

def real

Get real part of complex number(s).

real=

def real=

Set real part of complex number(s).

imag

def imag

Get imaginary part of complex number(s).

imag=

def imag=

Set imaginary part of complex numbers(s).

r

def r

Get red channel.

r=

def r=

Set red channel.

g

def g

Get green channel.

g=

def g=

Set green channel.

b

def b

Get blue channel.

b=

def b=

Set blue channel.

zero?

def zero?

Compare with zero.

Returns

true if equal to zero.

zero?

def nonzero?

Compare with zero.

Returns

true if not equal to zero.

-@

def -@

Compute additive inverse.

+@

def +@

Does nothing. Returns this object itself.

abs

def abs

Compute absolute value.

arg

def arg

Compute complex argument.

conj

def conj

Compute complex conjugate.

floor

def floor

Round to largest integer not greater than this value.

ceil

def ceil

Round to smallest integer not smaller than this value.

not

def not

Compute boolean “not”.

~

def ~

Compute bitwise “not”.

round

def round

Round to nearest integer.

and

def and( other )

Boolean “and”.

Parameters

other

second argument

or

def or( other )

Boolean “or”.

Parameters

other

second argument

&

def &( other )

Bitwise “and”.

Parameters

other

second argument

|

def |( other )

Bitwise “or”.

Parameters

other

second argument

^

def ^( other )

Bitwise “xor”.

Parameters

other

second argument

Lower-than comparison.

Parameters

other

second argument

def eq( other )

Equal-to comparison.

ne

def ne( other )

Not-equal-to comparison.

ge

def ge( other )

Same as >=

gt

def gt( other )

Same as >

le

def le( other )

Same as <=

lt

def lt( other )

Same as <

major

def major( other )

Choose larger value of two.

Parameters

other

second argument

minor

def minor( other )

Choose smaller value of two.

Parameters

other

second argument

Type

Functions

Type.inspect

Type.to_s

Type.to_str

Type._load

Type.element_type

Type.num_elements

Type.alloc

Parameters

Type.empty?

Returns

Type.dimension

Type.stride

Type.contiguous?

Type.contiguous

Type.strides

Type.shape

Type.size

Type.check_size

Type.check_shape

Type.check_filter

Type.layout

Type.contiguous?

Type.indgen

Type.typecode

Type.basetype

Type.rgb?

Type.bool

Type.float

Type.scalar

Type.floatscalar

Type.maxint

Type.byte

Type.to_type

Type.decompose

Type.boolean

Type.byteval

Type.largeint

Type.floating

Type.fit

Parameters

Type.match

Parameters

Type.align

Type.cache

Type.coerce

Type.coercion

Type.===

to_s

See also

export

to_str

coerce

_dump

element_type

num_elements

typecode

typesize

size

empty?

stride

layout

See also

contiguous?

See also

contiguous

See also

dimension

shape

See also

strides

width

See also

height

See also

basetype

rgb?

check_size

check_shape