PLSSVM - Parallel Least Squares Support Vector Machine  2.0.0
A Least Squares Support Vector Machine implementation using different backends.
Namespaces | Functions
git_metadata.hpp File Reference

Implements compile-time constants to query git information. More...

#include <string_view>

Go to the source code of this file.

Namespaces

 plssvm
 The main namespace containing all public API functions.
 
 plssvm::version
 Namespace containing versioning information.
 

Functions

bool plssvm::version::git_metadata::is_populated ()
 Check whether the metadata has been successfully populated. More...
 
bool plssvm::version::git_metadata::has_uncommitted_changes ()
 Check whether there are any uncommitted changes that won't be reflected in the CommitID. More...
 
std::string_view plssvm::version::git_metadata::author_name ()
 The name of the author of this commit. More...
 
std::string_view plssvm::version::git_metadata::author_email ()
 The E-Mail of the author of this commit. More...
 
std::string_view plssvm::version::git_metadata::commit_sha1 ()
 The full hash of the current commit. More...
 
std::string_view plssvm::version::git_metadata::commit_date ()
 The ISO 8601 commit date. More...
 
std::string_view plssvm::version::git_metadata::commit_subject ()
 The commit subject. More...
 
std::string_view plssvm::version::git_metadata::commit_body ()
 The commit body. More...
 
std::string_view plssvm::version::git_metadata::describe ()
 The commit description. More...
 
std::string_view plssvm::version::git_metadata::branch ()
 The symbolic reference tied to HEAD. More...
 
std::string_view plssvm::version::git_metadata::remote_url ()
 The remote repository URL. More...
 

Detailed Description

Implements compile-time constants to query git information.

Author
Alexander Van Craen
Marcel Breyer
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

◆ is_populated()

bool plssvm::version::git_metadata::is_populated ( )

Check whether the metadata has been successfully populated.

There may be no metadata of there wasn't a .git directory (e.g., downloaded source code without revision history).

Returns
true if the metadata has been successfully populated, otherwise false ([[nodiscard]])

◆ has_uncommitted_changes()

bool plssvm::version::git_metadata::has_uncommitted_changes ( )

Check whether there are any uncommitted changes that won't be reflected in the CommitID.

Returns
true if there are uncommitted changes, otherwise false ([[nodiscard]])

◆ author_name()

std::string_view plssvm::version::git_metadata::author_name ( )

The name of the author of this commit.

Returns
the configured name ([[nodiscard]])

◆ author_email()

std::string_view plssvm::version::git_metadata::author_email ( )

The E-Mail of the author of this commit.

Returns
the configured E-Mail ([[nodiscard]])

◆ commit_sha1()

std::string_view plssvm::version::git_metadata::commit_sha1 ( )

The full hash of the current commit.

Returns
the configured commit hash ([[nodiscard]])

◆ commit_date()

std::string_view plssvm::version::git_metadata::commit_date ( )

The ISO 8601 commit date.

Returns
the configured commit date ([[nodiscard]])

◆ commit_subject()

std::string_view plssvm::version::git_metadata::commit_subject ( )

The commit subject.

Returns
the configured subject ([[nodiscard]])

◆ commit_body()

std::string_view plssvm::version::git_metadata::commit_body ( )

The commit body.

Returns
the configured body ([[nodiscard]])

◆ describe()

std::string_view plssvm::version::git_metadata::describe ( )

The commit description.

Returns
the configured description ([[nodiscard]])

◆ branch()

std::string_view plssvm::version::git_metadata::branch ( )

The symbolic reference tied to HEAD.

Returns
the configured current branch name ([[nodiscard]])

◆ remote_url()

std::string_view plssvm::version::git_metadata::remote_url ( )

The remote repository URL.

Returns
the configured remote URL ([[nodiscard]])