starsh-minimal.h File Reference

#include "starsh.h"

Include dependency graph for starsh-minimal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	starsh_mindata
	Structure for minimal example. More...

Typedefs
typedef struct starsh_mindata	STARSH_mindata
	Structure for minimal example. More...

Enumerations
enum	STARSH_MINIMAL_KERNEL { STARSH_MINIMAL_KERNEL1 = 1 }
	List of built-in kernels for starsh_mindata_get_kernel(). More...

Functions
int	starsh_mindata_new (STARSH_mindata **data, STARSH_int count, char dtype)
	Create container for minimal working example. More...
void	starsh_mindata_free (STARSH_mindata *data)
int	starsh_mindata_get_kernel (STARSH_kernel **kernel, STARSH_mindata *data, enum STARSH_MINIMAL_KERNEL type)
	Get kernel for minimal working example. More...
void	starsh_mindata_block_kernel (int nrows, int ncols, STARSH_int *irow, STARSH_int *icol, void *row_data, void *col_data, void *result, int ld)
	The only kernel for STARSH_mindata object. More...

Detailed Description

Copyright

(c) 2017 King Abdullah University of Science and Technology (KAUST). All rights reserved.

STARS-H is a software package, provided by King Abdullah University of Science and Technology (KAUST)

Version

0.3.0

Author

Aleksandr Mikhalev

Date

2017-11-07

Function Documentation

starsh_mindata_block_kernel()

void starsh_mindata_block_kernel	(	int	nrows,
		int	ncols,
		STARSH_int *	irow,
		STARSH_int *	icol,
		void *	row_data,
		void *	col_data,
		void *	result,
		int	ld
	)

The only kernel for STARSH_mindata object.

Parameters

[in]	nrows	Number of rows of \( A \).
[in]	ncols	Number of columns of \( A \).
[in]	irow	Array of row indexes.
[in]	icol	Array of column indexes.
[in]	row_data	Pointer to physical data (STARSH_mindata object).
[in]	col_data	Pointer to physical data (STARSH_mindata object).
[out]	result	Pointer to memory of \( A \).
[in]	ld	Leading dimension of result.

starsh_mindata_free()

void starsh_mindata_free

(

STARSH_mindata *

data

)

Free data.

starsh_mindata_get_kernel()

int starsh_mindata_get_kernel	(	STARSH_kernel **	kernel,
		STARSH_mindata *	data,
		enum STARSH_MINIMAL_KERNEL	type
	)

Get kernel for minimal working example.

Kernel can be selected with this call or manually. Currently, there is only one kernel for STARSH_mindata problem.

Parameters

[out]	kernel	Address of STARSH_kernel function.
[in]	data	Pointer to STARSH_mindata object.
[in]	type	Type of kernel. For more info look at STARSH_MINIMAL_KERNEL.

Returns

Error code STARSH_ERRNO.

See also

starsh_mindata_block_kernel().

starsh_mindata_new()

int starsh_mindata_new	(	STARSH_mindata **	data,
		STARSH_int	count,
		char	dtype
	)

Create container for minimal working example.

Parameters

[out]	data	Address of pointer to STARSH_mindata object.
[in]	count	Size of matrix.
[in]	dtype	precision ('s', 'd', 'c' or 'z').

Returns

Error code STARSH_ERRNO.