C++ representation of J array. More...

#include <src/jarray.h>

Inheritance diagram for jarray:

Collaboration diagram for jarray:

[legend]

Data Structures
struct	header
	J array header. More...

struct	MS
	Layout of two words before every array, responsible for J memory management. More...

struct	Z
	complex type, equivalent to J More...

Public Types
enum	errorType { ERR_CONV =10 , ERR_SHAPE =11 }
	error codes More...

enum	elementType { T_B01 =1 , T_LIT =2 , T_INT =4 , T_FL =8 , T_CMPX =16 }
	Constants for possible array element types. More...

typedef char	B
	byte type, equivalent to J

typedef char	C
	literal type, equivalent to J

typedef short	S
	short int type, equivalent to J

typedef long	I
	integer type, equivalent to J

typedef double	D
	floating point type, equivalent to J

Public Member Functions
I	getRefcount () const
	returns the array refcount

template<class T >
int	get (T &v, const int i) const
	Obtains the value of a specified element of ravel.

template<class T >
int	set (const int i, const T v)
	Assigns the value of the specified element of ravel.

template<class T >
int	get (std::vector< T > &v) const
	Fits ravel of the array into the specified STL vector.

template<class T >
int	get (T &v)
	Attempts to fit the whole array into the specified type.

	jarray ()
	Invalid array, a valid array can be assigned to it.

	jarray (jengine *je_, std::istream &in)
	Loads the array from binary representation in a stream.

jarray::I	esize () const
	Size (in bytes) of the single element of this array.

void	addhash (SHA1 &sha)
	Add this array (both shape and values) to the hash.

bool	write (std::ostream &out)
	Writes binary representation of this array into the specified output stream.

bool	isValid () const
	Returns true if the array is valid.

const I	type () const
	Returns array type.

const I	rank () const
	Rank (dimensionality) of the array.

I *	shape () const
	Returns pointer to the first element of the shape.

int	extent (int dimension) const
	Returns the extent of the specified dimension, element of shape.

void	shape (std::vector< I > &shape) const
	Copies array shape into STL vector.

const int	size () const
	Number of elements in ravel.

I *	data () const
	Returns pointer to the beginning of the array data.

jengine *	getEngine () const
	Returns pointer to jengine, managing memory of this array.

	jarray (jengine je_, void hdr_)
	Instantiates on top of an existing J array.

	jarray (jengine je_, elementType type, I rank, I shape)
	Creates new multidimensional array of the given J type.

	jarray (jengine *je_, elementType type, const std::vector< I > &shape)
	Creates new multidimensional array of the given J type.

	jarray (jengine *je_, const std::string &str)
	Creates T_LIT vector from C++ string.

	jarray (const jarray &other)
	Makes a copy of another array (increments refcount).

jarray &	assign (const jarray &other)
	Assigns another array to this one (increments refcount and frees memory, if necessary)

jarray &	operator= (const jarray &other)
	Shortcut to assign.

bool	operator== (const jarray &rhs) const
	Performs by-element comparison and return true if two arrays are the same.

	~jarray ()
	Decrements refcount, frees array memory, if necessary.

Static Public Member Functions
static jarray::I	esize (elementType type)
	Size (in bytes) of the particular data type.

Protected Member Functions
bool	allocate (jengine je_, elementType type, const I rank, const I shape)
	Allocates new array in memory.

void	grab () const
	Increments refcount.

void	release ()
	Decrements refcount and frees memory, if necessary.

I	getHeader (bool give_up_ownership=true) const

Protected Attributes
header *	hdr
	Pointer to the array header, NULL for invalid array.

jengine *	je
	Pointer to jengine, managing the memory of this array.

Friends
class	jengine

Detailed Description

C++ representation of J array.

This is the direct mapping of J array into C++ domain, for support of typed arrays (with automatic type conversion and convenient element indexing) see jarray_of_type template class. Only non-sparse array types are currently supported. This class may operate in standalone mode (managing its memory via malloc), or, if J engine is initalized, it will cooperate with J on memory allocation and make use of J garbage collection (AKA tempstack).

Member Typedef Documentation

◆ B

typedef char jarray::B

byte type, equivalent to J

◆ C

typedef char jarray::C

literal type, equivalent to J

◆ D

typedef double jarray::D

floating point type, equivalent to J

◆ I

typedef long jarray::I

integer type, equivalent to J

◆ S

typedef short jarray::S

short int type, equivalent to J

Member Enumeration Documentation

◆ elementType

enum jarray::elementType

Constants for possible array element types.

Enumerator
T_B01	B boolean
T_LIT	C literal (character)
T_INT	I integer
T_FL	D double (IEEE floating point)
T_CMPX	Z complex

◆ errorType

enum jarray::errorType

error codes

Enumerator
ERR_CONV	data type conversion error
ERR_SHAPE	shape mismatch

Constructor & Destructor Documentation

◆ jarray() [1/7]

jarray::jarray ( )

Invalid array, a valid array can be assigned to it.

◆ jarray() [2/7]

jarray::jarray	(	jengine *	je_,
		std::istream &	in
	)

Loads the array from binary representation in a stream.

The representation can be created by the write method.

Parameters

je_	jengine to own the array's memory.
in	stream to read the array from.

◆ jarray() [3/7]

jarray::jarray	(	jengine *	je_,
		void *	hdr_
	)

Instantiates on top of an existing J array.

Parameters

je_	jengine to own the array memory.
hdr_	pointer to J array header.

◆ jarray() [4/7]

jarray::jarray	(	jengine *	je_,
		elementType	type,
		I	rank,
		I *	shape
	)

Creates new multidimensional array of the given J type.

Parameters

je_	jengine to own the array memory.
type	the type of new array (one of T_XXX).
rank	rank of the new array.
shape	pointer to elements of shape.

◆ jarray() [5/7]

jarray::jarray	(	jengine *	je_,
		elementType	type,
		const std::vector< I > &	shape
	)

Creates new multidimensional array of the given J type.

Parameters

je_	jengine to own the array memory.
type	the array type (one of T_XXX).
shape	the STL vector, holding elements of shape.

◆ jarray() [6/7]

jarray::jarray	(	jengine *	je_,
		const std::string &	str
	)

Creates T_LIT vector from C++ string.

Parameters

je_	jengine to own the array memory.
str	string the new array will contain.

◆ jarray() [7/7]

jarray::jarray ( const jarray & other )

Makes a copy of another array (increments refcount).

Parameters

other the array to copy.

◆ ~jarray()

jarray::~jarray ( )

Decrements refcount, frees array memory, if necessary.

Member Function Documentation

◆ addhash()

void jarray::addhash ( SHA1 & sha )

Add this array (both shape and values) to the hash.

Parameters

sha	hash to add the array to.

◆ allocate()

bool jarray::allocate	(	jengine *	je_,
		elementType	type,
		const I	rank,
		const I *	shape
	)

protected

Allocates new array in memory.

The memory if either malloc-ed (if the first argument is null), or, if passed non-null je pointer, allocated via jtga function of J engine.

Parameters

je_	jengine to manage the memory of this array.
type	type of the new array (one of T_XXXX).
rank	rank of the new array.
shape	shape of the new array.

Returns: true if success.

Referenced by jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), and jarray_of_type< T >::jarray_of_type().

◆ assign()

jarray & jarray::assign ( const jarray & other )

Assigns another array to this one (increments refcount and frees memory, if necessary)

Parameters

other array to assign to this one.

Returns: reference to this array.

Referenced by jarray_of_type< T >::jarray_of_type(), and operator=().

◆ data()

I * jarray::data ( ) const

inline

Returns pointer to the beginning of the array data.

Returns: pointer to array data.

References hdr, and jarray::header::offset.

◆ esize() [1/2]

jarray::I jarray::esize ( ) const

Size (in bytes) of the single element of this array.

◆ esize() [2/2]

static jarray::I jarray::esize ( elementType type )

static

Size (in bytes) of the particular data type.

Parameters

type	one of T_XXX constants).

Returns: size of the array element.

◆ extent()

int jarray::extent ( int dimension ) const

inline

Returns the extent of the specified dimension, element of shape.

Parameters

dimension the axis, whose size is requested.

Returns: dimension along the specified axis.

References rank(), and shape().

Referenced by jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), jarray_of_type< T >::operator()(), and jarray_of_type< T >::operator()().

◆ get() [1/3]

template<class T >

int jarray::get ( std::vector< T > & v ) const

inline

Fits ravel of the array into the specified STL vector.

The type must be convertible. Does copy.

Parameters

v	the STL vector to hold the copy of the array.

Returns: 0 on success.

References ERR_CONV, hdr, jarray::header::n, jarray::header::offset, T_B01, T_CMPX, T_FL, T_INT, T_LIT, and jarray::header::type.

◆ get() [2/3]

template<class T >

int jarray::get ( T & v )

Attempts to fit the whole array into the specified type.

Currently, this works for literal arrays, which can be fitted into C++ strings.

Parameters

v	place to store the array.

Returns: 0 on success.

◆ get() [3/3]

template<class T >

int jarray::get	(	T &	v,
		const int	i
	)		const

inline

Obtains the value of a specified element of ravel.

The type must be convertible.

Parameters

v	the place to store the value.
i	zero-based index of the element in ravel.

Returns: 0 on success.

References ERR_CONV, hdr, jarray::header::offset, T_B01, T_CMPX, T_FL, T_INT, T_LIT, and jarray::header::type.

Referenced by jarray_of_type< T >::jarray_of_type().

◆ getEngine()

jengine * jarray::getEngine ( ) const

inline

Returns pointer to jengine, managing memory of this array.

Returns: jengine, menaging the memory of this array, or NULL if the memory is managed autonomously (via malloc).

References je.

Referenced by jarray_of_type< T >::jarray_of_type().

◆ getHeader()

I jarray::getHeader ( bool give_up_ownership = true ) const

inlineprotected

References jarray::header::flag, and hdr.

◆ getRefcount()

I jarray::getRefcount ( ) const

inline

returns the array refcount

Returns: the array refcount.

References hdr, and jarray::header::refcnt.

◆ grab()

void jarray::grab ( ) const

protected

Increments refcount.

◆ isValid()

bool jarray::isValid ( ) const

inline

Returns true if the array is valid.

Returns: true if the array is valid.

References hdr.

◆ operator=()

jarray & jarray::operator= ( const jarray & other )

inline

Shortcut to assign.

Parameters

other array to assign to this one.

Returns: reference to this array.

References assign().

◆ operator==()

bool jarray::operator== ( const jarray & rhs ) const

Performs by-element comparison and return true if two arrays are the same.

Parameters

rhs	array to compare to.

Returns: true if arrays are the same.

◆ rank()

const I jarray::rank ( ) const

inline

◆ release()

void jarray::release ( )

protected

Decrements refcount and frees memory, if necessary.

◆ set()

template<class T >

int jarray::set	(	const int	i,
		const T	v
	)

inline

Assigns the value of the specified element of ravel.

The type must be convertible.

Parameters

i	zero-based index of the element to assign.
v	the value to put into the array.

Returns: 0 on success.

References ERR_CONV, hdr, jarray::header::offset, T_B01, T_CMPX, T_FL, T_INT, T_LIT, and jarray::header::type.

Referenced by jarray_of_type< T >::jarray_of_type().

◆ shape() [1/2]

I * jarray::shape ( ) const

inline

Returns pointer to the first element of the shape.

Returns: pointer to the shape.

References hdr, and jarray::header::shape.

Referenced by extent(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), jarray_of_type< T >::jarray_of_type(), and shape().

◆ shape() [2/2]

void jarray::shape ( std::vector< I > & shape ) const

inline

Copies array shape into STL vector.

Parameters

shape the vector to hold the requested shape.

References hdr, rank(), shape(), and jarray::header::shape.

◆ size()

const int jarray::size ( ) const

inline

Number of elements in ravel.

Returns: number of elements in ravel.

References hdr, rank(), and jarray::header::shape.

Referenced by jarray_of_type< T >::jarray_of_type().

◆ type()

const I jarray::type ( ) const

inline

Returns array type.

One of T_XXX constants.

Returns: type of the array elements.

References hdr, and jarray::header::type.

Referenced by jarray_of_type< T >::jarray_of_type().

◆ write()

bool jarray::write ( std::ostream & out )

Writes binary representation of this array into the specified output stream.

Parameters

out	the stream to write the array to.

Returns: true if successfully written.

Friends And Related Symbol Documentation

◆ jengine

friend class jengine

friend

Field Documentation

◆ hdr

header* jarray::hdr

protected

Pointer to the array header, NULL for invalid array.

Referenced by data(), get(), get(), getHeader(), getRefcount(), isValid(), rank(), set(), shape(), shape(), size(), and type().

◆ je

jengine* jarray::je

protected

Pointer to jengine, managing the memory of this array.

Referenced by getEngine().

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

src/jarray.h

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ B

◆ C

◆ D

◆ I

◆ S

Member Enumeration Documentation

◆ elementType

◆ errorType

Constructor & Destructor Documentation

◆ jarray() [1/7]

◆ jarray() [2/7]

◆ jarray() [3/7]

◆ jarray() [4/7]

◆ jarray() [5/7]

◆ jarray() [6/7]

◆ jarray() [7/7]

◆ ~jarray()

Member Function Documentation

◆ addhash()

◆ allocate()

◆ assign()

◆ data()

◆ esize() [1/2]

◆ esize() [2/2]

◆ extent()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getEngine()

◆ getHeader()

◆ getRefcount()

◆ grab()

◆ isValid()

◆ operator=()

◆ operator==()

◆ rank()

◆ release()

◆ set()

◆ shape() [1/2]

◆ shape() [2/2]

◆ size()

◆ type()

◆ write()

Friends And Related Symbol Documentation

◆ jengine

Field Documentation

◆ hdr

◆ je