array_util.h File Reference

---

Detailed Description

Some array manipulation utility functions for the test suite.

#include <oski/common.h>
#include <oski/mangle.h>

Go to the source code of this file.

Name mangling.
#define	array_Duplicate   MANGLE_(array_Duplicate)
#define	array_Destroy   MANGLE_(array_Destroy)
#define	array_CompareElems   MANGLE_(array_CompareElems)
#define	array_CompareElems_NoAbort   MANGLE_(array_CompareElems_NoAbort)
#define	array_FillRandom   MANGLE_(array_FillRandom)
#define	array_CreateRandom   MANGLE_(array_CreateRandom)
#define	array_Create   MANGLE_(array_Create)
#define	array_SortIndValPairs   MANGLE_(array_SortIndValPairs)
Defines
#define	INC_TESTS_ARRAY_UTIL_H
	util/array_util.h included.
Functions
oski_value_t *	array_Duplicate (const oski_value_t *x0, oski_index_t len)
	Returns a pointer to a newly allocated copy of the given array, or NULL on error.
void	array_Destroy (oski_value_t *x)
	Release previously allocated array.
void	array_CompareElems (const char *test_func, const oski_value_t *x, const oski_value_t *y, oski_index_t len)
	Compare elements of two arrays, and exit the program with an error code of 1 if the element-wise difference greater than len*(machine epsilon) is detected.
int	array_CompareElems_NoAbort (const char *test_func, const oski_value_t *x, const oski_value_t *y, oski_index_t len)
	Compare elements of two arrays, and exit the program with an error code of 1 if the element-wise difference greater than len*(machine epsilon) detected.
void	array_FillRandom (oski_value_t *x, oski_index_t n)
	Initialize an array with random values between -1 and 1.
oski_value_t *	array_CreateRandom (oski_index_t n)
	Allocate an array of random values between -1 and 1.
oski_value_t *	array_Create (oski_index_t n, oski_value_t val)
	Allocate an array with elements initialized to a particular value.
void	array_SortIndValPairs (oski_index_t *ind, oski_value_t *val, oski_index_t n)
	Sorts an (index, value) pair of arrays.

---

Function Documentation

void array_CompareElems (  const char *  test_func, const oski_value_t *  x, const oski_value_t *  y, oski_index_t  len )

Compare elements of two arrays, and exit the program with an error code of 1 if the element-wise difference greater than len*(machine epsilon) is detected. Parameters: [in]  test_func  Name of the calling test function. [in]  x  Expected results. [in]  y  Observed/computed results. [in]  len  Length of the x and y arrays.

int array_CompareElems_NoAbort (  const char *  test_func, const oski_value_t *  x, const oski_value_t *  y, oski_index_t  len )

Compare elements of two arrays, and exit the program with an error code of 1 if the element-wise difference greater than len*(machine epsilon) detected. Parameters: [in]  test_func  Name of the calling test function. [in]  x  Expected results. [in]  y  Observed/computed results. [in]  len  Length of the x and y arrays.

void array_Destroy (  oski_value_t *  x  )

Release previously allocated array. Parameters: [in,out]  x  Array to destroy. Postcondition: x no longer usable.

oski_value_t* array_Duplicate (  const oski_value_t *  x0, oski_index_t  len )

Returns a pointer to a newly allocated copy of the given array, or NULL on error. Parameters: [in]  x0  Array to copy. [in]  len  Number of elements to copy from x0. Returns: A newly allocated copy of x0, or NULL on error.

---