InitRuntime.hpp#

Defined in header Einsums/Runtime/InitRuntime.hpp.

See Overview for a list of names and headers that are part of the public Einsums API.

Defines

EINSUMS_APPLICATION_STRING#

namespace einsums

Todo:

Functions

int start(std::function<int()> f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::nullptr_t f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(int, char**)> f, std::vector<std::string> &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(int, char const*const*)> f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(std::vector<std::string>&)> f, std::vector<std::string> &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(std::vector<std::string> const&)> f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(int, char**)> f, int argc, char **argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of command line arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int start(std::function<int(int, char const*const*)> f, int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of command line arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

template<typename Function>
int start(Function &&f, int argc, char **argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

template<typename Function> int start(Function &&f, int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime and start a function.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of command line arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

void initialize(std::function<int(int, char**)> f, std::vector<std::string> &argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime. f will be passed all non-einsums command line arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is stopped

Post:

the runtime is running

void initialize(std::function<int(int, char const*const*)> f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

void initialize(std::function<int()> f, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

void initialize(std::nullptr_t, std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

inline void initialize(std::vector<std::string> const &argv, InitParams const &params = InitParams())#

Initialize the runtime.

No task is created on the runtime.

Parameters:

argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not initialized

Post:

the runtime is running

void initialize(std::function<int(int, char**)> f, int argc, char **argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

void initialize(std::function<int(int, char const*const*)> f, int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

void initialize(std::nullptr_t, int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

template<typename Function>
void initialize(Function &&f, int argc, char **argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

template<typename Function> void initialize(Function &&f, int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

f – entry point of the first task on the einsums runtime
argc – The number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

inline void initialize(int argc, char const *const *argv, InitParams const &params = InitParams())#

Initialize the runtime.

Parameters:

argc – Then number of arguments.
argv – array of arguments. The first element is ignored.
params – The initialization parameters.

Pre:

(argc == 0 && argv == nullptr) || (argc >= 1 && argv != nullptr)

Pre:

the runtime is not running

int finalize()#

Signal the runtime that it may be stopped.

Pre:: the runtime is initialized

struct InitParams#

#include <InitRuntime.hpp>

Todo:: Document.

Public Members

mutable StartupFunctionType startup#

mutable ShutdownFunctionType shutdown#