Extensions — taxonomy#

Ginkgo’s extensions/ tree holds optional integrations with third-party libraries. Each extension is opt-in at build time via a CMake flag, and lives in its own namespace under gko::ext. None of them are required by the core library; they exist so that Ginkgo can plug into ecosystems where users already have data, executors, or solvers. This page surveys the available extensions and points to their dedicated pages.

What lives in extensions/#

Extension

Header

Namespace

Purpose

Kokkos interop

<ginkgo/extensions/kokkos.hpp>

gko::ext::kokkos

Wrap Kokkos execution spaces as Ginkgo executors and map Ginkgo containers to Kokkos Views.

cuDSS direct solver

<ginkgo/extensions/cuda/solver/cudss.hpp>

gko::ext::cuda::solver

Sparse direct solver wrapper around NVIDIA’s cuDSS library.

JSON / YAML config

<ginkgo/extensions/config/json_config.hpp>, <ginkgo/extensions/config/yaml_config.hpp>

gko::ext::config

Parse solver configurations from JSON or YAML files. See Configuration from JSON files for the user-facing interface.

The first two each have their own page below. The config extension is documented in its own concept page because configuration is a first-class user-facing topic, not just a build-time integration.

Build-time enablement#

Each extension is opt-in at build time, but the activation mechanism is not the same across them:

Extension

How to enable

Kokkos interop

Configure with -DGINKGO_EXTENSION_KOKKOS=ON and have a Kokkos installation discoverable by CMake.

cuDSS

Build Ginkgo with -DGINKGO_BUILD_CUDA=ON and let CMake’s find_package(cudss CONFIG) discover a cuDSS install. Point -Dcudss_DIR=<path> (or set CMAKE_PREFIX_PATH) at the directory containing cudssConfig.cmake if cuDSS is not in a default location. There is no separate GINKGO_BUILD_EXT_CUDSS flag — the extension is built whenever cuDSS is found and skipped silently otherwise.

JSON / YAML config

Configure with -DGINKGO_EXTENSION_CONFIG_BUILD_JSON=ON / -DGINKGO_EXTENSION_CONFIG_BUILD_YAML=ON.

If the dependency cannot be found or the flag is off, the corresponding header is not installed and the extension’s namespace is not available.

Per-extension pages#

Extensions

See also