SC::Vector< T > Struct Template Reference

A contiguous sequence of heap allocated elements. More...

#include <Vector.h>

Inheritance diagram for SC::Vector< T >:

Public Types
using	Parent = Segment< detail::VectorVTable< T > >

Public Member Functions
template<typename U >
bool	contains (const U &value, size_t *index=nullptr) const noexcept
	Check if the current array contains a given value. More...
template<typename Lambda >
bool	find (Lambda &&lambda, size_t *index=nullptr) const noexcept
	Finds the first item in array matching criteria given by the lambda. More...
template<typename Lambda >
bool	removeAll (Lambda &&criteria) noexcept
	Removes all items matching criteria given by Lambda. More...
template<typename U >
bool	remove (const U &value) noexcept
	Removes all values equal to value More...

Detailed Description

template<typename T>
struct SC::Vector< T >

A contiguous sequence of heap allocated elements.

Template Parameters

T	Type of single vector element

All methods of SC::Vector that can fail, return a [[nodiscard]] bool (example SC::Vector::push_back).
Assignment and Copy / move construct operators will just assert as they can't return a failure code.
memcpy is used to optimize copies when T is a memcpy-able object.

Note

Use SC::SmallVector everywhere a SC::Vector reference is needed if the upper bound size of required elements is known to get rid of unnecessary heap allocations.

    Vector<int> myVector;
    SC_TRY(myVector.reserve(10));
    SC_TRY(myVector.push_back(1));
    console.print("[0]={}", myVector[0]);
    SC_TRY(myVector.push_back(2));
    SC_TRY(myVector.pop_back());
    SC_TRY(myVector.pop_front());
    console.print("Vector<int> is {}", myVector.isEmpty() ? "empty" : "not empty");

Member Function Documentation

contains()

template<typename T >

template<typename U >

bool SC::Vector< T >::contains ( const U &  value, size_t *  index = nullptr  ) const

inlinenoexcept

Check if the current array contains a given value.

Template Parameters

U	Type of the object being searched

Parameters

value	Value being searched
index	if passed in != nullptr, receives index where item was found. Only written if function returns true

Returns

true if the array contains the given value.

find()

template<typename T >

template<typename Lambda >

bool SC::Vector< T >::find ( Lambda &&  lambda, size_t *  index = nullptr  ) const

inlinenoexcept

Finds the first item in array matching criteria given by the lambda.

Template Parameters

Lambda

Type of the Lambda passed that declares a bool operator()(const T&) operator

Parameters

lambda	The functor or lambda called that evaluates to true when item is found
index	if passed in != nullptr, receives index where item was found.

Returns

true if the wanted value with given criteria is found.

remove()

template<typename T >

template<typename U >

bool SC::Vector< T >::remove ( const U &  value )

inlinenoexcept

Removes all values equal to value

Template Parameters

U	Type of the Value

Parameters

value

Value to be removed

Returns

true if at least one item has been removed

removeAll()

template<typename T >

template<typename Lambda >

bool SC::Vector< T >::removeAll ( Lambda &&  criteria )

inlinenoexcept

Removes all items matching criteria given by Lambda.

Template Parameters

Lambda

Type of the functor/lambda with a bool operator()(const T&) operator

Parameters

criteria

The lambda/functor passed in

Returns

true if at least one item has been removed

---

The documentation for this struct was generated from the following file:

• Vector.h