Algorithms

🟥 Placeholder library templated where algorithms will be placed (see Algorithms for more details) More...

Classes
struct	SC::Algorithms::smallerThan< T >
	Functor that evaluates to a < b More...

Functions
template<typename Iterator , typename BinaryPredicate = smallerThan<typename TypeTraits::RemovePointer<Iterator>::type>>
constexpr void	SC::Algorithms::bubbleSort (Iterator first, Iterator last, BinaryPredicate predicate=BinaryPredicate())
	Sorts iterator range according to BinaryPredicate (bubble sort).
template<typename ForwardIterator , typename UnaryPredicate >
constexpr ForwardIterator	SC::Algorithms::findIf (ForwardIterator first, ForwardIterator last, UnaryPredicate &&predicate, size_t *index=nullptr)
	Find item satisfying the given predicate.
template<typename Container , typename T >
constexpr bool	SC::Algorithms::contains (Container container, const T &value, size_t *index=nullptr)
	Check if the container contains a given value.
template<typename ForwardIterator , typename UnaryPredicate >
ForwardIterator	SC::Algorithms::removeIf (ForwardIterator first, ForwardIterator last, UnaryPredicate &&predicate)
	Removes all items in the given range, satisfying the given predicate.
template<typename T >
constexpr const T &	SC::min (const T &t1, const T &t2)
	Finds the minimum of two values.
template<typename T >
constexpr const T &	SC::max (const T &t1, const T &t2)
	Finds the maximum of two values.

Detailed Description

🟥 Placeholder library templated where algorithms will be placed (see Algorithms for more details)

Function Documentation

bubbleSort()

template<typename Iterator , typename BinaryPredicate = smallerThan<typename TypeTraits::RemovePointer<Iterator>::type>>

void SC::Algorithms::bubbleSort ( Iterator first, Iterator last, BinaryPredicate predicate = BinaryPredicate() )

constexpr

#include <AlgorithmBubbleSort.h>

Sorts iterator range according to BinaryPredicate (bubble sort).

Template Parameters

Iterator	A type that behaves as an iterator (can just be a pointer to element in array / vector)
BinaryPredicate	A predicate that takes (a, b) and returns bool (example SC::Algorithms::smallerThan)

Parameters

first	Iterator pointing at first element of the range
last	Iterator pointing at last element of the array
predicate	The given BinaryPredicate

contains()

template<typename Container , typename T >

bool SC::Algorithms::contains ( Container container, const T & value, size_t * index = nullptr )

constexpr

#include <AlgorithmFind.h>

Check if the container contains a given value.

Template Parameters

Container	A container with begin and end iterators
T	The type of the value to search for

Parameters

container	The container to search in
value	The value to search for
index	if passed in != nullptr, receives index where item was found. Only written if function returns true

Returns

true if the container contains the given value, false otherwise

findIf()

template<typename ForwardIterator , typename UnaryPredicate >

ForwardIterator SC::Algorithms::findIf ( ForwardIterator first, ForwardIterator last, UnaryPredicate && predicate, size_t * index = nullptr )

constexpr

#include <AlgorithmFind.h>

Find item satisfying the given predicate.

Template Parameters

ForwardIterator	A forward iterator (supports ++ and dereference operators)
UnaryPredicate	A lambda or functor predicate with a bool (const T&) operator

Parameters

first	Iterator pointing at the first item in the range to check
last	Iterator pointing after last item in the range to check
predicate	The functor or lambda predicate that decides if wanted item is found
index	if passed in != nullptr, receives index where item was found. Only written if function returns true

Returns

Iterator pointing at the found item or last if not found

max()

template<typename T >

const T & SC::max ( const T & t1, const T & t2 )

constexpr

#include <Compiler.h>

Finds the maximum of two values.

min()

template<typename T >

const T & SC::min ( const T & t1, const T & t2 )

constexpr

#include <Compiler.h>

Finds the minimum of two values.

removeIf()

template<typename ForwardIterator , typename UnaryPredicate >

ForwardIterator SC::Algorithms::removeIf	(	ForwardIterator	first,
		ForwardIterator	last,
		UnaryPredicate &&	predicate )

#include <AlgorithmRemove.h>

Removes all items in the given range, satisfying the given predicate.

Template Parameters

ForwardIterator	A forward iterator (supports ++ and dereference operators)
UnaryPredicate	A lambda or functor predicate with a bool (const T&) operator

Parameters

first	Iterator pointing at the first item in the range to check
last	Iterator pointing after last item in the range to check
predicate	The functor or lambda predicate that decides if current item must be removed

Returns

last