Classes
class	BasicStaticString
	A fixed-capacity string class that owns its storage. More...

class	SparseSet
	A sparse set data structure for efficient mapping of sparse indices to dense storage of values. More...

Typedefs
template<size_t N>
using	StaticString = BasicStaticString< N, char >
	Fixed-capacity string of char.

template<size_t N>
using	StaticWString = BasicStaticString< N, wchar_t >
	Fixed-capacity string of wchar_t.

template<size_t N>
using	StaticU8String = BasicStaticString< N, char8_t >
	Fixed-capacity string of char8_t.

template<size_t N>
using	StaticU16String = BasicStaticString< N, char16_t >
	Fixed-capacity string of char16_t.

template<size_t N>
using	StaticU32String = BasicStaticString< N, char32_t >
	Fixed-capacity string of char32_t.

Functions
template<typename T , typename IndexType , typename Allocator >
void	swap (SparseSet< T, IndexType, Allocator > &lhs, SparseSet< T, IndexType, Allocator > &rhs) noexcept
	Swaps two sparse sets.

template<size_t N1, size_t N2, typename CharT , typename Traits >
constexpr auto	operator+ (const BasicStaticString< N1, CharT, Traits > &lhs, const BasicStaticString< N2, CharT, Traits > &rhs) noexcept -> BasicStaticString< N1+N2, CharT, Traits >
	Concatenates two StaticStrings.

template<size_t N, typename CharT , typename Traits >
constexpr auto	operator+ (const BasicStaticString< N, CharT, Traits > &lhs, std::basic_string_view< CharT, Traits > rhs) noexcept -> BasicStaticString< N, CharT, Traits >
	Concatenates StaticString with string_view.

template<size_t N, typename CharT , typename Traits >
constexpr auto	operator+ (std::basic_string_view< CharT, Traits > lhs, const BasicStaticString< N, CharT, Traits > &rhs) noexcept -> BasicStaticString< N, CharT, Traits >
	Concatenates string_view with StaticString.

template<size_t N, typename CharT , typename Traits >
constexpr auto	operator+ (const BasicStaticString< N, CharT, Traits > &lhs, CharT rhs) noexcept -> BasicStaticString< N, CharT, Traits >
	Concatenates StaticString with character.

template<size_t N, typename CharT , typename Traits >
constexpr auto	operator+ (CharT lhs, const BasicStaticString< N, CharT, Traits > &rhs) noexcept -> BasicStaticString< N, CharT, Traits >
	Concatenates character with StaticString.

template<size_t StrCapacity, typename CharT , typename Traits >
constexpr void	swap (BasicStaticString< StrCapacity, CharT, Traits > &lhs, BasicStaticString< StrCapacity, CharT, Traits > &rhs) noexcept
	Swaps two BasicStaticStrings.

template<size_t StrCapacity, typename CharT , typename Traits >
constexpr auto	erase (BasicStaticString< StrCapacity, CharT, Traits > &str, CharT value) noexcept -> typename BasicStaticString< StrCapacity, CharT, Traits >::size_type
	Erases all elements equal to value.

template<size_t StrCapacity, typename CharT , typename Traits , typename Pred >
constexpr auto	erase_if (BasicStaticString< StrCapacity, CharT, Traits > &str, Pred pred) noexcept -> typename BasicStaticString< StrCapacity, CharT, Traits >::size_type
	Erases all elements satisfying predicate.

template<size_t StrCapacity, typename CharT , typename Traits >
auto	operator<< (std::basic_ostream< CharT, Traits > &os, const BasicStaticString< StrCapacity, CharT, Traits > &str) -> std::basic_ostream< CharT, Traits > &
	Outputs a BasicStaticString to an output stream.

template<size_t StrCapacity, typename CharT , typename Traits >
auto	operator>> (std::basic_istream< CharT, Traits > &is, BasicStaticString< StrCapacity, CharT, Traits > &str) -> std::basic_istream< CharT, Traits > &
	Inputs a BasicStaticString from an input stream.

Typedef Documentation

◆ StaticString

template<size_t N>

using helios::container::StaticString = typedef BasicStaticString<N, char>

Fixed-capacity string of char.

Template Parameters

N	Maximum capacity

Definition at line 1414 of file static_string.hpp.

◆ StaticU16String

template<size_t N>

using helios::container::StaticU16String = typedef BasicStaticString<N, char16_t>

Fixed-capacity string of char16_t.

Template Parameters

N	Maximum capacity

Definition at line 1435 of file static_string.hpp.

◆ StaticU32String

template<size_t N>

using helios::container::StaticU32String = typedef BasicStaticString<N, char32_t>

Fixed-capacity string of char32_t.

Template Parameters

N	Maximum capacity

Definition at line 1442 of file static_string.hpp.

◆ StaticU8String

template<size_t N>

using helios::container::StaticU8String = typedef BasicStaticString<N, char8_t>

Fixed-capacity string of char8_t.

Template Parameters

N	Maximum capacity

Definition at line 1428 of file static_string.hpp.

◆ StaticWString

template<size_t N>

using helios::container::StaticWString = typedef BasicStaticString<N, wchar_t>

Fixed-capacity string of wchar_t.

Template Parameters

N	Maximum capacity

Definition at line 1421 of file static_string.hpp.

Function Documentation

◆ erase()

template<size_t StrCapacity, typename CharT , typename Traits >

constexpr auto helios::container::erase	(	BasicStaticString< StrCapacity, CharT, Traits > &	str,
		CharT	value
	)		-> typename BasicStaticString<StrCapacity, CharT, Traits>::size_type

constexprnoexcept

Erases all elements equal to value.

Template Parameters

StrCapacity	StrCapacity of the string
CharT	Character type
Traits	Character traits

Parameters

str	String to modify
value	Value to erase

Returns: Number of elements erased

Definition at line 1562 of file static_string.hpp.

                                                                    {
  const auto original_size = str.Size();
  auto* new_end = std::remove(str.begin(), str.end(), value);
  str.Resize(static_cast<typename BasicStaticString<StrCapacity, CharT, Traits>::size_type>(new_end - str.begin()));
  return original_size - str.Size();
}

◆ erase_if()

template<size_t StrCapacity, typename CharT , typename Traits , typename Pred >

constexpr auto helios::container::erase_if	(	BasicStaticString< StrCapacity, CharT, Traits > &	str,
		Pred	pred
	)		-> typename BasicStaticString<StrCapacity, CharT, Traits>::size_type

constexprnoexcept

Erases all elements satisfying predicate.

Template Parameters

StrCapacity	StrCapacity of the string
CharT	Character type
Traits	Character traits
Pred	Predicate type

Parameters

str	String to modify
pred	Unary predicate

Returns: Number of elements erased

Definition at line 1581 of file static_string.hpp.

                                                                    {
  const auto original_size = str.Size();
  auto* new_end = std::remove_if(str.begin(), str.end(), pred);
  str.Resize(static_cast<typename BasicStaticString<StrCapacity, CharT, Traits>::size_type>(new_end - str.begin()));
  return original_size - str.Size();
}

◆ operator+() [1/5]

template<size_t N, typename CharT , typename Traits >

constexpr auto helios::container::operator+	(	CharT	lhs,
		const BasicStaticString< N, CharT, Traits > &	rhs
	)		-> BasicStaticString<N, CharT, Traits>

constexprnoexcept

Concatenates character with StaticString.

Warning: Triggers assertion if rhs.Size() >= N.

Template Parameters

N	StrCapacity of the static string
CharT	Character type
Traits	Character traits

Parameters

lhs	Character
rhs	Static string

Returns: Concatenated string (same capacity as rhs)

Definition at line 1531 of file static_string.hpp.

                                           {
  BasicStaticString<N, CharT, Traits> result(1, lhs);
  result.Append(rhs.View());
  return result;
}

◆ operator+() [2/5]

template<size_t N, typename CharT , typename Traits >

constexpr auto helios::container::operator+	(	const BasicStaticString< N, CharT, Traits > &	lhs,
		CharT	rhs
	)		-> BasicStaticString<N, CharT, Traits>

constexprnoexcept

Concatenates StaticString with character.

Warning: Triggers assertion if lhs.Size() >= N.

Template Parameters

N	StrCapacity of the static string
CharT	Character type
Traits	Character traits

Parameters

lhs	Static string
rhs	Character

Returns: Concatenated string (same capacity as lhs)

Definition at line 1513 of file static_string.hpp.

                                           {
  BasicStaticString<N, CharT, Traits> result = lhs;
  result.PushBack(rhs);
  return result;
}

◆ operator+() [3/5]

template<size_t N, typename CharT , typename Traits >

constexpr auto helios::container::operator+	(	const BasicStaticString< N, CharT, Traits > &	lhs,
		std::basic_string_view< CharT, Traits >	rhs
	)		-> BasicStaticString<N, CharT, Traits>

constexprnoexcept

Concatenates StaticString with string_view.

Warning: Triggers assertion if combined length > N.

Template Parameters

N	StrCapacity of the static string
CharT	Character type
Traits	Character traits

Parameters

lhs	Static string
rhs	String view

Returns: Concatenated string (same capacity as lhs)

Definition at line 1475 of file static_string.hpp.

                                           {
  BasicStaticString<N, CharT, Traits> result = lhs;
  result.Append(rhs);
  return result;
}

◆ operator+() [4/5]

template<size_t N1, size_t N2, typename CharT , typename Traits >

constexpr auto helios::container::operator+	(	const BasicStaticString< N1, CharT, Traits > &	lhs,
		const BasicStaticString< N2, CharT, Traits > &	rhs
	)		-> BasicStaticString<N1 + N2, CharT, Traits>

constexprnoexcept

Concatenates two StaticStrings.

Template Parameters

N1	StrCapacity of first string
N2	StrCapacity of second string
CharT	Character type
Traits	Character traits

Parameters

lhs	First string
rhs	Second string

Returns: Concatenated string with capacity N1 + N2

Definition at line 1455 of file static_string.hpp.

                                                 {
  BasicStaticString<N1 + N2, CharT, Traits> result;
  result.Append(lhs.View());
  result.Append(rhs.View());
  return result;
}

◆ operator+() [5/5]

template<size_t N, typename CharT , typename Traits >

constexpr auto helios::container::operator+	(	std::basic_string_view< CharT, Traits >	lhs,
		const BasicStaticString< N, CharT, Traits > &	rhs
	)		-> BasicStaticString<N, CharT, Traits>

constexprnoexcept

Concatenates string_view with StaticString.

Warning: Triggers assertion if combined length > N.

Template Parameters

N	StrCapacity of the static string
CharT	Character type
Traits	Character traits

Parameters

lhs	String view
rhs	Static string

Returns: Concatenated string (same capacity as rhs)

Definition at line 1494 of file static_string.hpp.

                                           {
  BasicStaticString<N, CharT, Traits> result(lhs);
  result.Append(rhs.View());
  return result;
}

◆ operator<<()

template<size_t StrCapacity, typename CharT , typename Traits >

auto helios::container::operator<<	(	std::basic_ostream< CharT, Traits > &	os,
		const BasicStaticString< StrCapacity, CharT, Traits > &	str
	)		-> std::basic_ostream<CharT, Traits>&

inline

Outputs a BasicStaticString to an output stream.

Template Parameters

StrCapacity	StrCapacity of the string
CharT	Character type
Traits	Character traits

Parameters

os	Output stream
str	String to output

Returns: Reference to the output stream

Definition at line 1599 of file static_string.hpp.

                                        {
  return os << str.View();
}

◆ operator>>()

template<size_t StrCapacity, typename CharT , typename Traits >

auto helios::container::operator>>	(	std::basic_istream< CharT, Traits > &	is,
		BasicStaticString< StrCapacity, CharT, Traits > &	str
	)		-> std::basic_istream<CharT, Traits>&

inline

Inputs a BasicStaticString from an input stream.

Template Parameters

StrCapacity	StrCapacity of the string
CharT	Character type
Traits	Character traits

Parameters

is	Input stream
str	String to input

Returns: Reference to the input stream

Definition at line 1614 of file static_string.hpp.

                                        {
  std::basic_string<CharT, Traits> temp;
  is >> temp;
  if (temp.size() <= StrCapacity) {
    str.Assign(temp);
  } else {
    is.setstate(std::ios_base::failbit);
  }
  return is;
}

◆ swap() [1/2]

template<size_t StrCapacity, typename CharT , typename Traits >

constexpr void helios::container::swap	(	BasicStaticString< StrCapacity, CharT, Traits > &	lhs,
		BasicStaticString< StrCapacity, CharT, Traits > &	rhs
	)

constexprnoexcept

Swaps two BasicStaticStrings.

Template Parameters

StrCapacity	StrCapacity of the strings
CharT	Character type
Traits	Character traits

Parameters

lhs	First string
rhs	Second string

Definition at line 1547 of file static_string.hpp.

                                                                                 {
  lhs.Swap(rhs);
}

◆ swap() [2/2]

template<typename T , typename IndexType , typename Allocator >

void helios::container::swap	(	SparseSet< T, IndexType, Allocator > &	lhs,
		SparseSet< T, IndexType, Allocator > &	rhs
	)

noexcept

Swaps two sparse sets.

Non-member swap function for efficient swapping of sparse sets. Time complexity: O(1). Exception safety: No-throw guarantee.

Template Parameters

T	Type of values stored
IndexType	Type used for indices
Allocator	Allocator type

Parameters

lhs	First sparse set
rhs	Second sparse set

Definition at line 698 of file sparse_set.hpp.

                                                                                                     {
  lhs.Swap(rhs);
}

	Helios Engine 0.1.0 A modular ECS based data-oriented C++23 game engine

Classes

Typedefs

Functions

Typedef Documentation

◆ StaticString

◆ StaticU16String

◆ StaticU32String

◆ StaticU8String

◆ StaticWString

Function Documentation

◆ erase()

◆ erase_if()

◆ operator+() [1/5]

◆ operator+() [2/5]

◆ operator+() [3/5]

◆ operator+() [4/5]

◆ operator+() [5/5]

◆ operator<<()

◆ operator>>()

◆ swap() [1/2]

◆ swap() [2/2]