Implements compile-time constants to query the current library version. More...

#include <optional>
#include <string>
#include <string_view>

This graph shows which files directly or indirectly include this file:

Namespaces
	plssvm
	The main namespace containing all public API functions.

	plssvm::version
	Namespace containing versioning information.

Functions
std::optional< std::string >	plssvm::version::detail::get_git_info ()
	Special git information used in the `--version` message. More...

std::string	plssvm::version::detail::get_version_info (std::string_view executable_name, bool with_backend_info=true)
	The full content used for the `--version` message. More...

Variables
constexpr std::string_view	plssvm::version::name = "PLSSVM - Parallel Least Squares Support Vector Machine"
	The name of the library. More...

constexpr std::string_view	plssvm::version::version = "2.0.0"
	The current version of the library in the form: "major.minor.patch". More...

constexpr int	plssvm::version::major = 2
	The current major version of the library. More...

constexpr int	plssvm::version::minor = 0
	The current minor version of the library. More...

constexpr int	plssvm::version::patch = 0
	The current patch version of the library. More...

constexpr std::string_view	plssvm::version::detail::target_platforms = "cpu"
	The provided target platforms to use. More...

constexpr std::string_view	plssvm::version::detail::copyright_notice
	The copyright notice of the PLSSVM library. More...

Detailed Description

Implements compile-time constants to query the current library version.

Author: Alexander Van Craen; Marcel Breyer

Copyright: 2018-today The PLSSVM project - All Rights Reserved

License: This file is part of the PLSSVM project which is released under the MIT license. See the LICENSE.md file in the project root for full license information.

Function Documentation

◆ get_git_info()

std::optional<std::string> plssvm::version::detail::get_git_info ( )

Special git information used in the --version message.

If no git could be found, returns a std::nullopt

Returns: the git information: remote url, branch, commit sha1, and commit data ([[nodiscard]])

◆ get_version_info()

std::string plssvm::version::detail::get_version_info	(	std::string_view	executable_name,
		bool	with_backend_info = `true`
	)

The full content used for the --version message.

Contains the executable name, library version, git information, available target platforms, backends, and SYCL implementations (if applicable), and the copyright notice.

Parameters

[in]	executable_name	the name of the executable to generate the `--version` message for
[in]	with_backend_info	if `true`, also includes backend specific information in the version message

Returns: the information used for the --version message ([[nodiscard]])

Variable Documentation

◆ target_platforms

constexpr std::string_view plssvm::version::detail::target_platforms = "cpu"

constexpr

The provided target platforms to use.

The value gets automatically set during the CMake configuration step.

◆ copyright_notice

constexpr std::string_view plssvm::version::detail::copyright_notice

constexpr

Initial value:

"This is free software distributed under the MIT license; see the source for more information."

The copyright notice of the PLSSVM library.

Namespaces

Functions