Low-level API

The Ginkgo.API submodule provides a low-level interface which closely matches the Ginkgo C API. While these functions are not intended for general usage, they are useful for calling Ginkgo routines not yet available in Ginkgo.jl main interface, and is the basis for the high-level wrappers. For illustrative purpose, we use a example api.jl here, yet to be replaced.

Ginkgo.API.ginkgo_dim2_cols_get Method

ginkgo_dim2_cols_get(dim)

Obtains the value of the second element of a gko::dim<2> type

Parameters

• dim: An object of gko_dim2_st type

Returns

size_t Second dimension

source

Ginkgo.API.ginkgo_dim2_create Method

ginkgo_dim2_create(rows, cols)

Allocates memory for a C-based reimplementation of the gko::dim<2> type

Parameters

• rows: First dimension

• cols: Second dimension

Returns

gko_dim2_st C struct that contains members of the gko::dim<2> type

source

Ginkgo.API.ginkgo_dim2_rows_get Method

ginkgo_dim2_rows_get(dim)

Obtains the value of the first element of a gko::dim<2> type

Parameters

• dim: An object of gko_dim2_st type

Returns

size_t First dimension

source

Ginkgo.API.ginkgo_executor_delete Method

ginkgo_executor_delete(exec_st_ptr)

Deallocates memory for an executor on targeted device.

Parameters

• exec_st_ptr: Raw pointer to the shared pointer of the executor to be deleted

source

Ginkgo.API.ginkgo_matrix_csr_f32_i32_apply Method

ginkgo_matrix_csr_f32_i32_apply(mat_st_ptr, alpha, x, beta, y)

Performs an SpMM product

Parameters

• mat_st_ptr:

• alpha:

• x:

• beta:

• y:

source

Ginkgo.API.ginkgo_version_get Method

ginkgo_version_get()

This function is a wrapper for obtaining the version of the ginkgo library

source

Ginkgo.API.gko_dim2_st Type

gko_dim2_st

Struct implements the gko::dim<2> type

source

Ginkgo.API.gko_executor Type

Type of the pointer to the wrapped gko_executor_st struct

source

Ginkgo.API.gko_executor_st Type

Struct containing the shared pointer to a ginkgo executor

source