capi.h File Reference

C API for Lattice Builder. More...

#include <stddef.h>

Typedefs
typedef enum latbuilder_status_	latbuilder_status
	Status types for the functions of the Lattice Builder C API. More...
typedef struct latbuilder_result_	latbuilder_result
	Structure used to store search results. More...

Enumerations
enum	latbuilder_status_ { LATBUILDER_OK = 0, LATBUILDER_IN_PROGRESS = 1, LATBUILDER_ERROR = -1 }
	Status types for the functions of the Lattice Builder C API. More...

Functions
const char *	latbuilder_get_version_string ()
	Return a string describing the current version of Lattice Builder. More...
const char *	latbuilder_get_error_string ()
	Return the error string associated with the last error that occurred. More...
void	latbuilder_release_result (latbuilder_result *result)
	Release the memory resources associated with result. More...
unsigned long	latbuilder_result_get_num_points (const latbuilder_result *result)
	Return the number of points of the lattice. More...
size_t	latbuilder_result_get_dimension (const latbuilder_result *result)
	Return the dimension of the lattice. More...
const unsigned long *	latbuilder_result_get_gen (const latbuilder_result *result)
	Return the generating vector (as an array) of the lattice. More...
double	latbuilder_result_get_merit (const latbuilder_result *result)
	Return the merit value of the lattice. More...
double	latbuilder_result_get_cpu_seconds (const latbuilder_result *result)
	Return the CPU time (in seconds) used to construct the lattice.
latbuilder_status	latbuilder_search_ordinary_str (const char *construction, const char *size, const char *dimension, const char *norm_type, const char *figure, size_t weight_count, const char **weights, const char *weights_power, size_t filter_count, const char **filters, latbuilder_result **result)
	Search for an ordinary lattice rule using string arguments. More...
latbuilder_status	latbuilder_search_embedded_str (const char *construction, const char *size, const char *dimension, const char *norm_type, const char *figure, size_t weight_count, const char **weights, const char *weights_power, size_t filter_count, const char **filters, size_t multilevel_filter_count, const char **multilevel_filters, const char *combiner, latbuilder_result **result)
	Search for embedded lattice rules using string arguments. More...

Detailed Description

C API for Lattice Builder.

IMPORTANT: Programs that use the C API must link with the standard C++ library (libstdc++).

Typedef Documentation

typedef struct latbuilder_result_ latbuilder_result

Structure used to store search results.

typedef enum latbuilder_status_ latbuilder_status

Status types for the functions of the Lattice Builder C API.

Enumeration Type Documentation

enum latbuilder_status_

Status types for the functions of the Lattice Builder C API.

Function Documentation

const char* latbuilder_get_error_string

(

)

Return the error string associated with the last error that occurred.

Examples:

capi.c.

const char* latbuilder_get_version_string

(

)

Return a string describing the current version of Lattice Builder.

Examples:

capi.c.

void latbuilder_release_result

(

latbuilder_result *

result

)

Release the memory resources associated with result.

size_t latbuilder_result_get_dimension

(

const latbuilder_result *

result

)

Return the dimension of the lattice.

Examples:

capi.c.

const unsigned long* latbuilder_result_get_gen

(

const latbuilder_result *

result

)

Return the generating vector (as an array) of the lattice.

Examples:

capi.c.

double latbuilder_result_get_merit

(

const latbuilder_result *

result

)

Return the merit value of the lattice.

Examples:

capi.c.

unsigned long latbuilder_result_get_num_points

(

const latbuilder_result *

result

)

Return the number of points of the lattice.

Examples:

capi.c.

latbuilder_status latbuilder_search_embedded_str	(	const char *	construction,
		const char *	size,
		const char *	dimension,
		const char *	norm_type,
		const char *	figure,
		size_t	weight_count,
		const char **	weights,
		const char *	weights_power,
		size_t	filter_count,
		const char **	filters,
		size_t	multilevel_filter_count,
		const char **	multilevel_filters,
		const char *	combiner,
		latbuilder_result **	result
	)

Search for embedded lattice rules using string arguments.

Returns

LATBUILDER_OK on success, or LATBUILDER_ERROR on error (see latbuilder_get_error_string()).

Examples:

capi.c.

latbuilder_status latbuilder_search_ordinary_str	(	const char *	construction,
		const char *	size,
		const char *	dimension,
		const char *	norm_type,
		const char *	figure,
		size_t	weight_count,
		const char **	weights,
		const char *	weights_power,
		size_t	filter_count,
		const char **	filters,
		latbuilder_result **	result
	)

Search for an ordinary lattice rule using string arguments.

Returns

LATBUILDER_OK on success, or LATBUILDER_ERROR on error (see latbuilder_get_error_string()).

Examples:

capi.c.