IODA
Files | Classes | Functions
Dimensions
IODA » Interfaces » C interface » API

Provides the C-style interface for ioda::Dimensions objects. More...

Collaboration diagram for Dimensions:

Files

file  Dimensions_c.h
 C bindings for ioda::Dimensions
 
file  Dimensions_c.cpp
 C bindings for ioda::Dimensions
 

Classes

struct  c_dimensions
 Class-like encapsulation of C dimension-manipulating functions. More...
 

Functions

IODA_DL void ioda_dimensions_destruct (struct ioda_dimensions *d)
 Deallocates a dimensions container. More...
 
IODA_DL bool ioda_dimensions_get_dimensionality (const struct ioda_dimensions *d, size_t *val)
 Gets dimensionality (i.e. number of dimensions) More...
 
IODA_DL bool ioda_dimensions_set_dimensionality (struct ioda_dimensions *d, size_t N)
 Set dimensionality of the dimensions container. More...
 
IODA_DL bool ioda_dimensions_get_num_elements (const struct ioda_dimensions *d, size_t *val)
 Get the number of distinct elements in the dimensions object (the product of each dimension size). More...
 
IODA_DL bool ioda_dimensions_get_dim_cur (const struct ioda_dimensions *d, size_t n, ptrdiff_t *val)
 Get the current size of the n-th dimension. More...
 
IODA_DL bool ioda_dimensions_set_dim_cur (struct ioda_dimensions *d, size_t n, ptrdiff_t sz)
 Set the current size of the n-th dimension. More...
 
IODA_DL bool ioda_dimensions_get_dim_max (const struct ioda_dimensions *d, size_t n, ptrdiff_t *val)
 Get the maximum size of the n-th dimension. More...
 
IODA_DL bool ioda_dimensions_set_dim_max (struct ioda_dimensions *d, size_t n, ptrdiff_t sz)
 Set the maximum size of the n-th dimension. More...
 
bool ioda_dimensions_get_dimensionality (const ioda_dimensions *d, size_t *res)
 
bool ioda_dimensions_get_num_elements (const ioda_dimensions *d, size_t *res)
 
bool ioda_dimensions_get_dim_cur (const ioda_dimensions *d, size_t n, ptrdiff_t *res)
 
bool ioda_dimensions_get_dim_max (const ioda_dimensions *d, size_t n, ptrdiff_t *res)
 

Detailed Description

Provides the C-style interface for ioda::Dimensions objects.

Function Documentation

◆ ioda_dimensions_destruct()

void ioda_dimensions_destruct ( struct ioda_dimensions *  d)

Deallocates a dimensions container.

Parameters
[in]dis the dimensions object to be destructed.

Definition at line 20 of file Dimensions_c.cpp.

Here is the caller graph for this function:

◆ ioda_dimensions_get_dim_cur() [1/2]

bool ioda_dimensions_get_dim_cur ( const ioda_dimensions *  d,
size_t  n,
ptrdiff_t *  res 
)

Definition at line 55 of file Dimensions_c.cpp.

◆ ioda_dimensions_get_dim_cur() [2/2]

IODA_DL bool ioda_dimensions_get_dim_cur ( const struct ioda_dimensions *  d,
size_t  n,
ptrdiff_t *  val 
)

Get the current size of the n-th dimension.

Parameters
[in]dis the dimensions object.
nis the nth dimension. Count starts at zero.
[out]valstores the size of the dimension.
Returns
true on success, false on failure.
Precondition
d must be a valid object.
n must be less than the dimensionality of d (see ioda_dimensions_get_dimensionality).
val must be a valid for output.
Postcondition
val is filled on function success and is unchanged on failure.
Here is the caller graph for this function:

◆ ioda_dimensions_get_dim_max() [1/2]

bool ioda_dimensions_get_dim_max ( const ioda_dimensions *  d,
size_t  n,
ptrdiff_t *  res 
)

Definition at line 72 of file Dimensions_c.cpp.

◆ ioda_dimensions_get_dim_max() [2/2]

IODA_DL bool ioda_dimensions_get_dim_max ( const struct ioda_dimensions *  d,
size_t  n,
ptrdiff_t *  val 
)

Get the maximum size of the n-th dimension.

Parameters
[in]dis the dimensions object.
nis the nth dimension. Count starts at zero.
[out]valstores the maximum size of the dimension.
Returns
true on success, false on failure.
Precondition
d must be a valid object.
n must be less than the dimensionality of d (see ioda_dimensions_get_dimensionality).
val must be a valid for output.
Postcondition
val is filled on function success and is unchanged on failure.
Here is the caller graph for this function:

◆ ioda_dimensions_get_dimensionality() [1/2]

bool ioda_dimensions_get_dimensionality ( const ioda_dimensions *  d,
size_t *  res 
)

Definition at line 27 of file Dimensions_c.cpp.

◆ ioda_dimensions_get_dimensionality() [2/2]

IODA_DL bool ioda_dimensions_get_dimensionality ( const struct ioda_dimensions *  d,
size_t *  val 
)

Gets dimensionality (i.e. number of dimensions)

Parameters
[in]dis the dimensions object.
[out]valstores the dimensionality of d.
Returns
true on success, false on failure.
Precondition
val must be valid (exist and be non-null).
d must be valid.
Postcondition
val is filled with the dimensionality on success. On failure, it is unchanged.
Here is the caller graph for this function:

◆ ioda_dimensions_get_num_elements() [1/2]

bool ioda_dimensions_get_num_elements ( const ioda_dimensions *  d,
size_t *  res 
)

Definition at line 47 of file Dimensions_c.cpp.

◆ ioda_dimensions_get_num_elements() [2/2]

IODA_DL bool ioda_dimensions_get_num_elements ( const struct ioda_dimensions *  d,
size_t *  val 
)

Get the number of distinct elements in the dimensions object (the product of each dimension size).

Parameters
[in]dis the dimensions object.
[out]valstores the number of elements.
Returns
true on success, false on failure.
Precondition
d must be a valid object.
val must be valid.
Postcondition
val is filled on function success and is unchanged on failure.
Here is the caller graph for this function:

◆ ioda_dimensions_set_dim_cur()

bool ioda_dimensions_set_dim_cur ( struct ioda_dimensions *  d,
size_t  n,
ptrdiff_t  sz 
)

Set the current size of the n-th dimension.

Parameters
[in]dis the dimensions object.
nis the nth dimension. Count starts at zero.
szis the new size of the dimension.
Returns
true on success, false on failure.
Precondition
d must be a valid object.
n must be less than the dimensionality of d (see ioda_dimensions_get_dimensionality).
Postcondition
Dimension size is only set on success. Unchanged on failure.

Definition at line 64 of file Dimensions_c.cpp.

Here is the caller graph for this function:

◆ ioda_dimensions_set_dim_max()

bool ioda_dimensions_set_dim_max ( struct ioda_dimensions *  d,
size_t  n,
ptrdiff_t  sz 
)

Set the maximum size of the n-th dimension.

Parameters
[in]dis the dimensions object.
nis the nth dimension. Count starts at zero.
szis the new size of the dimension.
Returns
true on success, false on failure.
Precondition
d must be a valid object.
n must be less than the dimensionality of d (see ioda_dimensions_get_dimensionality).
Postcondition
Dimension max size is only set on success. Unchanged on failure.

Definition at line 81 of file Dimensions_c.cpp.

Here is the caller graph for this function:

◆ ioda_dimensions_set_dimensionality()

bool ioda_dimensions_set_dimensionality ( struct ioda_dimensions *  d,
size_t  N 
)

Set dimensionality of the dimensions container.

Parameters
[in]dis the dimensions object.
[in]Nis the new dimensionality.
Returns
true on success, false on failure.
Precondition
d must be a valid object.

Definition at line 35 of file Dimensions_c.cpp.

Here is the caller graph for this function: