bpf::Name class
#include <Base/include/Framework/Name.hpp>

Contents

Utility class to represent a hashed string. By default this class uses the register size of the current system to store the hash number

Public static functions

static auto Hash32(const char* str) -> uint32 noexcept
static auto Hash32(const String& str) -> uint32 noexcept
static auto Hash64(const char* str) -> uint64 noexcept
static auto Hash64(const String& str) -> uint64 noexcept

Constructors, destructors, conversion operators

Name() noexcept
Name(const char* str) explicit noexcept
Name(const String& str) explicit noexcept
Name(fsize hash) explicit noexcept

Public functions

auto Hash() const -> fsize noexcept
auto operator==(const Name& other) const -> bool noexcept
auto operator!=(const Name& other) const -> bool noexcept

Function documentation

static uint32 bpf::Name::Hash32(const char* str) noexcept

Parameters
str string to hash
Returns 32 bits unsigned

Computes 32 bits string hash

static uint32 bpf::Name::Hash32(const String& str) noexcept

Parameters
str high-level string to hash
Returns 32 bits unsigned

Computes 32 bits string hash

static uint64 bpf::Name::Hash64(const char* str) noexcept

Parameters
str string to hash
Returns 64 bits unsigned

Computes 64 bits string hash

static uint64 bpf::Name::Hash64(const String& str) noexcept

Parameters
str high-level string to hash
Returns 64 bits unsigned

Computes 64 bits string hash

bpf::Name::Name() noexcept

Initialize an empty Name

bpf::Name::Name(const char* str) explicit noexcept

Parameters
str the low-level null-terminated c-string to build a hash from

Construct a Name from a low-level string

bpf::Name::Name(const String& str) explicit noexcept

Parameters
str the high-level string to build a hash from

Constructs a Name from a high-level string

bpf::Name::Name(fsize hash) explicit noexcept

Parameters
hash the hash to copy

Constructs a Name from an existing hash

fsize bpf::Name::Hash() const noexcept

Returns the hash value for the current platform register size

Returns the hash value

bool bpf::Name::operator==(const Name& other) const noexcept

Returns true if the two Names are equal false otherwise

Compare Name

bool bpf::Name::operator!=(const Name& other) const noexcept

Returns false if the two Names are equal true otherwise

Compare Name