#include <stdio.h>
#include <math.h>

Include dependency graph for cs_cdo_toolbox.h:

Data Structures
struct	cs_tmpbuf_t

struct	cs_connect_index_t

struct	cs_locmat_t

struct	cs_locdec_t

union	cs_data_t

struct	cs_data_info_t

Functions
double	cs_euclidean_norm (int len, const double v[])
	Compute the euclidean norm 2 of a vector of size len This algorithm tries to reduce round-off error thanks to intermediate sums. More...

double	cs_weighted_sum_square (cs_lnum_t n, const double restrict x, const double restrict weight)
	Compute the weighted sum of square values of an array. More...

void	cs_tmpbuf_alloc (size_t bufsize, cs_tmpbuf_t **p_tb)
	Allocate or reallocate a temporary buffer structure. More...

cs_tmpbuf_t *	cs_tmpbuf_free (cs_tmpbuf_t *tb)
	Free a temporary buffer structure. More...

cs_data_info_t	cs_analysis_data (cs_lnum_t n_elts, int stride, cs_datatype_t datatype, const void *indata, bool do_abs)
	Compute some simple statistics from an array. More...

void	cs_data_info_dump (const char name, FILE f, cs_lnum_t n_elts, cs_datatype_t datatype, const cs_data_info_t dinfo)
	Dump a cs_data_info_t structure. More...

cs_connect_index_t *	cs_index_create (int n)
	Create an index structure of size n. More...

cs_connect_index_t *	cs_index_map (int n, int idx, int ids)
	Map arrays into an index structure of size n (owner = false) More...

void	cs_index_free (cs_connect_index_t **pidx)
	Destroy a cs_connect_index_t structure. More...

cs_connect_index_t *	cs_index_compose (int nc, const cs_connect_index_t a2b, const cs_connect_index_t b2c)
	From 2 indexes : A -> B and B -> C create a new index A -> C. More...

cs_connect_index_t *	cs_index_transpose (int nb, const cs_connect_index_t *a2b)
	From a cs_connect_index_t struct. A -> B create a new index B -> A. More...

void	cs_index_sort (cs_connect_index_t *x)
	Sort each list related to an entry in a cs_connect_index_t structure. More...

void	cs_index_dump (const char name, FILE _f, cs_connect_index_t *x)
	Dump a cs_connect_index_t structure to a file or into the standard output. More...

cs_locmat_t *	cs_locmat_create (int n_max_ent)
	Allocate and initialize a cs_locmat_t structure. More...

cs_locmat_t *	cs_locmat_free (cs_locmat_t *lm)
	Free a cs_locmat_t structure. More...

void	cs_locmat_copy (cs_locmat_t recv, const cs_locmat_t send)
	Copy a cs_locmat_t structure into another cs_locmat_t structure which has been already allocated. More...

void	cs_locmat_matvec (const cs_locmat_t loc, const cs_real_t vec, cs_real_t *matvec)
	Compute a local dense matrix-vector product matvec has been previously allocated. More...

void	cs_locmat_add (cs_locmat_t loc, const cs_locmat_t add)
	Add two local dense matrices: loc += add. More...

void	cs_locmat_mult_add (cs_locmat_t loc, double alpha, const cs_locmat_t add)
	Give the result of the following operation: loc = loc + alpha*add. More...

void	cs_locmat_add_transpose (cs_locmat_t loc, cs_locmat_t tr)
	Define a new matrix by adding a local matrix with its transpose. Keep the transposed matrix for future use. More...

void	cs_locmat_dump (int parent_id, const cs_locmat_t *lm)
	Dump a local discrete Hodge operator. More...

cs_locdec_t *	cs_locdec_create (int n_max_rows, int n_max_cols)
	Allocate and initialize a cs_locdec_t structure. More...

cs_locdec_t *	cs_locdec_free (cs_locdec_t *m)
	Free a cs_locdec_t structure. More...

Function Documentation

◆ cs_analysis_data()

cs_data_info_t cs_analysis_data	(	cs_lnum_t	n_elts,
		int	stride,
		cs_datatype_t	datatype,
		const void *	indata,
		bool	do_abs
	)

Compute some simple statistics from an array.

Parameters

[in]	n_elts	number of couples in data
[in]	stride	size of a couple of data
[in]	datatype	datatype
[in]	indata	buffer containing input data
[in]	do_abs	analyse the absolute value of indata

Returns: a cs_data_info_t structure

◆ cs_data_info_dump()

void cs_data_info_dump	(	const char *	name,
		FILE *	f,
		cs_lnum_t	n_elts,
		cs_datatype_t	datatype,
		const cs_data_info_t	dinfo
	)

Dump a cs_data_info_t structure.

Parameters

[in]	name	filename if not NULL
[in]	f	output file if not NULL
[in]	n_elts	number of couples in data
[in]	datatype	datatype
[in]	dinfo	cs_data_info_t structure

◆ cs_euclidean_norm()

double cs_euclidean_norm	(	int	len,
		const double	v[]
	)

Compute the euclidean norm 2 of a vector of size len This algorithm tries to reduce round-off error thanks to intermediate sums.

Parameters

[in]	len	vector dimension
[in]	v	vector

Returns: the euclidean norm of a vector

◆ cs_index_compose()

cs_connect_index_t* cs_index_compose	(	int	nc,
		const cs_connect_index_t *	a2b,
		const cs_connect_index_t *	b2c
	)

From 2 indexes : A -> B and B -> C create a new index A -> C.

Parameters

[in]	nc	number of elements in C set
[in]	a2b	pointer to the index A -> B
[in]	b2c	pointer to the index B -> C

Returns: a pointer to the cs_connect_index_t structure A -> C

◆ cs_index_create()

cs_connect_index_t* cs_index_create ( int n )

Create an index structure of size n.

Parameters

[in] n number of entries of the indexed list

Returns: a pointer to a cs_connect_index_t

◆ cs_index_dump()

void cs_index_dump	(	const char *	name,
		FILE *	_f,
		cs_connect_index_t *	x
	)

Dump a cs_connect_index_t structure to a file or into the standard output.

Parameters

[in]	name	name of the dump file. Can be set to NULL
[in]	_f	pointer to a FILE structure. Can be set to NULL.
[in]	x	pointer to a cs_connect_index_t structure

◆ cs_index_free()

void cs_index_free ( cs_connect_index_t ** pidx )

Destroy a cs_connect_index_t structure.

Parameters

[in] pidx pointer of pointer to a cs_connect_index_t structure

◆ cs_index_map()

cs_connect_index_t* cs_index_map	(	int	n,
		int *	idx,
		int *	ids
	)

Map arrays into an index structure of size n (owner = false)

Parameters

[in]	n	number of entries of the indexed list
[in]	idx	array of size n+1
[in]	ids	array of size idx[n]

Returns: a pointer to a cs_connect_index_t

◆ cs_index_sort()

void cs_index_sort ( cs_connect_index_t * x )

Sort each list related to an entry in a cs_connect_index_t structure.

Parameters

[in] x pointer to a cs_connect_index_t structure

Sort each list related to an entry in a cs_connect_index_t structure.

Parameters

[in] x pointer to a cs_connect_index_t structure

◆ cs_index_transpose()

cs_connect_index_t* cs_index_transpose	(	int	nb,
		const cs_connect_index_t *	a2b
	)

From a cs_connect_index_t struct. A -> B create a new index B -> A.

Parameters

[in]	nb	size of the "b" set
[in]	a2b	pointer to the index A -> B

Returns: a new pointer to the cs_connect_index_t structure B -> A

From a cs_connect_index_t struct. A -> B create a new index B -> A.

Parameters

[in]	nb	size of the "b" set
[in]	a2b	pointer to the index A -> B

Returns: a new pointer to the cs_connect_index_t structure B -> A

◆ cs_locdec_create()

cs_locdec_t* cs_locdec_create	(	int	n_max_rows,
		int	n_max_cols
	)

Allocate and initialize a cs_locdec_t structure.

Parameters

[in]	n_max_rows	max number of rows
[in]	n_max_cols	max number of columns

Returns: a new allocated cs_locdec_t structure

◆ cs_locdec_free()

cs_locdec_t* cs_locdec_free ( cs_locdec_t * m )

Free a cs_locdec_t structure.

Parameters

[in,out] m pointer to a cs_locdec_t structure to free

Returns: a NULL pointer

◆ cs_locmat_add()

void cs_locmat_add	(	cs_locmat_t *	loc,
		const cs_locmat_t *	add
	)

Add two local dense matrices: loc += add.

Parameters

[in,out]	loc	local matrix storing the result
[in]	add	values to add to loc

◆ cs_locmat_add_transpose()

void cs_locmat_add_transpose	(	cs_locmat_t *	loc,
		cs_locmat_t *	tr
	)

Define a new matrix by adding a local matrix with its transpose. Keep the transposed matrix for future use.

Parameters

[in,out]	loc	local matrix to transpose and add
[in,out]	tr	transposed of the local matrix

◆ cs_locmat_copy()

void cs_locmat_copy	(	cs_locmat_t *	recv,
		const cs_locmat_t *	send
	)

Copy a cs_locmat_t structure into another cs_locmat_t structure which has been already allocated.

Parameters

[in,out]	recv	pointer to a cs_locmat_t struct.
[in]	send	pointer to a cs_locmat_t struct.

◆ cs_locmat_create()

cs_locmat_t* cs_locmat_create ( int n_max_ent )

Allocate and initialize a cs_locmat_t structure.

Parameters

[in] n_max_ent max number of entities

Returns: a new allocated cs_locmat_t structure

◆ cs_locmat_dump()

void cs_locmat_dump	(	int	parent_id,
		const cs_locmat_t *	lm
	)

Dump a local discrete Hodge operator.

Parameters

[in]	parent_id	id of the related parent entity
[in]	lm	pointer to the cs_sla_locmat_t struct.

◆ cs_locmat_free()

cs_locmat_t* cs_locmat_free ( cs_locmat_t * lm )

Free a cs_locmat_t structure.

Parameters

[in] lm pointer to a cs_locmat_t struct. to free

Returns: a NULL pointer

◆ cs_locmat_matvec()

void cs_locmat_matvec	(	const cs_locmat_t *	loc,
		const cs_real_t *	vec,
		cs_real_t *	matvec
	)

Compute a local dense matrix-vector product matvec has been previously allocated.

Parameters

[in]	loc	local matrix to use
[in]	vec	local vector to use
[in,out]	matvec	result of the local matrix-vector product

◆ cs_locmat_mult_add()

void cs_locmat_mult_add	(	cs_locmat_t *	loc,
		double	alpha,
		const cs_locmat_t *	add
	)

Give the result of the following operation: loc = loc + alpha*add.

Parameters

[in,out]	loc	local matrix storing the result
[in]	alpha	multiplicative coefficient
[in]	add	values to add to loc

◆ cs_tmpbuf_alloc()

void cs_tmpbuf_alloc	(	size_t	bufsize,
		cs_tmpbuf_t **	p_tb
	)

Allocate or reallocate a temporary buffer structure.

Parameters

[in]	bufsize	reference size
[in,out]	p_tb	pointer to the temporary structure to allocate

◆ cs_tmpbuf_free()

cs_tmpbuf_t* cs_tmpbuf_free ( cs_tmpbuf_t * tb )

Free a temporary buffer structure.

Parameters

[in] tb pointer to the temporary structure to free

Returns: NULL pointer

◆ cs_weighted_sum_square()

double cs_weighted_sum_square	(	cs_lnum_t	n,
		const double *restrict	x,
		const double *restrict	weight
	)

Compute the weighted sum of square values of an array.

Parameters

[in]	n	size of arrays v and w
[in]	x	array of floating-point values
[in]	w	floating-point values of weights

Returns: the result of this operation

Parameters

[in]	n	size of arrays x and weight
[in]	x	array of floating-point values
[in]	weight	floating-point values of weights

Returns: the result of this operation

Data Structures

Functions

Function Documentation

◆ cs_analysis_data()

◆ cs_data_info_dump()

◆ cs_euclidean_norm()

◆ cs_index_compose()

◆ cs_index_create()

◆ cs_index_dump()

◆ cs_index_free()

◆ cs_index_map()

◆ cs_index_sort()

◆ cs_index_transpose()

◆ cs_locdec_create()

◆ cs_locdec_free()

◆ cs_locmat_add()

◆ cs_locmat_add_transpose()

◆ cs_locmat_copy()

◆ cs_locmat_create()

◆ cs_locmat_dump()

◆ cs_locmat_free()

◆ cs_locmat_matvec()

◆ cs_locmat_mult_add()

◆ cs_tmpbuf_alloc()

◆ cs_tmpbuf_free()

◆ cs_weighted_sum_square()