Mir 1.0
Mir application programming interface

Functions

mirkl_error_tmir_fvc_instance_create (mirkl_object_t **obj, mirkl_size_t nVals, double *vals, mirkl_uint32_t flags, mir_prsdata_t *pp, apr_pool_t *pool, apr_pool_t *tmp_pool)
 
mirkl_error_tmir_fvc_instance_create_range (mirkl_object_t **obj, mirkl_size_t nVals, double vmin, double vstep, mirkl_uint32_t flags, mir_prsdata_t *pp, apr_pool_t *pool, apr_pool_t *tmp_pool)
 
mirkl_error_tmir_fvc_set_data (mirkl_object_t *obj, mirkl_size_t nVals, double *vals)
 
mirkl_error_tmir_fvc_set_data_range (mirkl_object_t *obj, mirkl_size_t nVals, double vmin, double vstep)
 
mirkl_error_tmir_fvc_get_data (mirkl_object_t *obj, mirkl_size_t *nVals, double **vals)
 
mirkl_error_tmir_fvc_get_data_ptr (mirkl_object_t *obj, mirkl_size_t *nVals, double **vals)
 
mirkl_error_tmir_fvc_resize (mirkl_object_t *obj, mirkl_size_t newsize)
 

Variables

mirkl_object_t * MirFVectorClass
 Float Vector class.
 

Detailed Description

Function Documentation

◆ mir_fvc_get_data()

mirkl_error_t * mir_fvc_get_data ( mirkl_object_t *  obj,
mirkl_size_t *  nVals,
double **  vals 
)

Getting data from fvector.

Parameters
objObject from which the data to be retrieved.
nValsNumber of elements in vector on the output.
valsarray of values on the output. Warning: this buffer must be freed by user!
Note
This function can be used to query only the length of the vector by sending NULL as the last parameter.

◆ mir_fvc_get_data_ptr()

mirkl_error_t * mir_fvc_get_data_ptr ( mirkl_object_t *  obj,
mirkl_size_t *  nVals,
double **  vals 
)

Getting pointers to the data of fvector for fast access.

Parameters
objObject from which the data to be retrieved.
nValsNumber of elements in vector on the output.
valsarray of values on the output.
Note
This function can be used to query only the length of the vector by sending NULL as the last parameter.

◆ mir_fvc_instance_create()

mirkl_error_t * mir_fvc_instance_create ( mirkl_object_t **  obj,
mirkl_size_t  nVals,
double *  vals,
mirkl_uint32_t  flags,
mir_prsdata_t *  pp,
apr_pool_t *  pool,
apr_pool_t *  tmp_pool 
)

Creation of fvector.

Parameters
[out]objReference to the created object.
nValsNumber of values for initialization.
valsArray of values for initialization. Can be freed after this function.
flagsFlags of the object.
ppReference to the parser data structure.
poolThe pool to use for allocations of object structures. Should be valid as long as the created object lives.
tmp_poolThe pool for temporary allocations. Can be deleted after calling this function.

◆ mir_fvc_instance_create_range()

mirkl_error_t * mir_fvc_instance_create_range ( mirkl_object_t **  obj,
mirkl_size_t  nVals,
double  vmin,
double  vstep,
mirkl_uint32_t  flags,
mir_prsdata_t *  pp,
apr_pool_t *  pool,
apr_pool_t *  tmp_pool 
)

Creation of ranged fvector.

Parameters
[out]objReference to the created object.
nValsNumber of values for initialization.
vminFirst (minimal) value in the vector.
vstepSize of step for generation of next values in the vector.
flagsFlags of the object.
ppReference to the parser data structure.
poolThe pool to use for allocations of object structures. Should be valid as long as the created object lives.
tmp_poolThe pool for temporary allocations. Can be deleted after calling this function.

◆ mir_fvc_resize()

mirkl_error_t * mir_fvc_resize ( mirkl_object_t *  obj,
mirkl_size_t  newsize 
)

Resizes fvector.

Parameters
newsizeNew size of the fvector.

◆ mir_fvc_set_data()

mirkl_error_t * mir_fvc_set_data ( mirkl_object_t *  obj,
mirkl_size_t  nVals,
double *  vals 
)

Set values of fvector.

Parameters
nValsNumber of values.
valsArray of values. Can be freed after this function.