`finalize`¶

Defined in header <Kokkos_Core.hpp>

Usage¶

Kokkos::finalize();

Terminates the Kokkos execution environment. This functions cleans up all Kokkos states and released the associated resources. Once this function is called, no Kokkos API functions (not even initialize()) may be called, except for is_initialized() or is_finalized(). The user must ensure that all Kokkos objects (e.g. View) are destroyed before finalize gets called.

Programs are ill-formed if they do not call this function after calling initialize(), before program termination.

Interface¶

void finalize();¶

Preconditions:

is_initialized() returns true
is_finalized() returns false

Examples¶

#include <Kokkos_Core.hpp>

int main(int argc, char* argv[]) {
    Kokkos::initialize(argc, argv);
    {  // scope to ensure that my_view destructor is called before Kokkos::finalize
        Kokkos::View<double*> my_view("my_view", 10);
    }  // scope of my_view ends here
    Kokkos::finalize();
}

#include <Kokkos_Core.hpp>
#include <cstdlib>

int main(int argc, char* argv[]) {
    Kokkos::initialize(argc, argv);
    std::atexit(Kokkos::finalize); // register to be called on program termination
    Kokkos::View<double*> my_view("my_view", 10);
} // my_view is properly destructed before Kokkos::finalize