User Guide

User Guide#

This is the main page for the Ginkgo library user documentation. The repository is hosted on github. Documentation on aspects such as the build system, can be found at the install page. The Examples can help you get started with using Ginkgo.

The Ginkgo library can be grouped into modules which form the basic building blocks of Ginkgo. The modules can be summarized as follows:

  • Executor : Where do you want your code to be executed ?

  • LinOp : What kind of operation do you want Ginkgo to perform ?

    • solvers : Solve a linear system for a given matrix.

    • precond : Precondition a linear system.

    • mat_formats : Perform a sparse matrix vector multiplication with a particular matrix format.

  • log : Monitor your code execution.

  • stop : Manage your iteration stopping criteria.