Einsums/RuntimeConfiguration/RuntimeConfiguration.hpp#

Defined in header Einsums/RuntimeConfiguration/RuntimeConfiguration.hpp.

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

namespace einsums

Todo:

Functions

void register_arguments(std::function<void()>)#

Add a function to the list of startup functions to add module-specific command line arguments.

Added in version 1.0.0.

struct RuntimeConfiguration#
#include <RuntimeConfiguration.hpp>

Handles the current configuration state of the running instance.

Currently, defaults are handled in pre_initialize. Eventually, some kind of configuration file will be implemented that will override the defaults set in pre_initialize.

The current instance of the RuntimeConfiguration can be obtained from Runtime::config() or from runtime_config() functions.

Added in version 1.0.0.

Public Functions

RuntimeConfiguration(int argc, char const *const *argv, std::function<void()> const &user_command_line = {})#

Constructor of the runtime configuration object of einsums.

Added in version 1.0.0.

Parameters:

  • argc – [in] the argc argument from main

  • argv – [in] the argv argument from main

  • user_command_line – [in] callback function that can be used to register additional command-line options

explicit RuntimeConfiguration(std::vector<std::string> const &argv, std::function<void()> const &user_command_line = {})#

Constructor of the runtime configuration object of einsums. This is used when argv has been packaged into a vector.

Added in version 1.0.0.

Parameters:

  • argv – [in] The argv that has been packaged up.

  • user_command_line – [in] callback function that can be used to register additional command-line options

RuntimeConfiguration() = delete#

Public Members

std::vector<std::string> original#

Todo:

Document.

Added in version 1.0.0.

Private Functions

void pre_initialize()#

Currently sets reasonable defaults for the development of Einsums.

Added in version 1.0.0.

std::vector<std::string> parse_command_line(std::function<void()> const &user_command_line = {})#

Parse the command line arguments provided in argc and argv. Returns unknown command line arguments.

Added in version 1.0.0.

Parameters:

user_command_line – [in] Callbiack function that can be used to register additional command-line arguments.