AVector< StoredType, Allocator > Class Template Reference

A std::vector with AUI extensions. More...

#include <AUI/Common/AVector.h>

Detailed Description

template<class StoredType, class Allocator>
class AVector< StoredType, Allocator >

Examples

examples/7guis/cells/src/AST.cpp, examples/7guis/cells/src/Functions.h, examples/7guis/cells/src/Spreadsheet.h, examples/7guis/cells/src/Tokens.cpp, examples/7guis/cells/src/Tokens.h, examples/app/minesweeper/src/MinesweeperWindow.h, examples/ui/views/src/DemoGraphView.h, and examples/ui/views/src/ExampleWindow.cpp.

Member Function Documentation

> All members, including inherited

contains()

template<class StoredType, class Allocator>

bool AVector< StoredType, Allocator >::contains ( const StoredType & value ) const

inlinenoexcept

Returns

true if container contains an element, false otherwise.

findIf()

template<class StoredType, class Allocator>

template<aui::predicate< StoredType > Predicate>

StoredType * AVector< StoredType, Allocator >::findIf ( Predicate && predicate )

inlinenodiscardnoexcept

Parameters

predicate

predicate

Returns

Pointer to the value on which the predicate returned true, nullptr otherwise

first() [1/2]

template<class StoredType, class Allocator>

const StoredType & AVector< StoredType, Allocator >::first ( ) const

inlinenodiscardnoexcept

Sneaky assertions

Container is not empty.

Returns

the first element.

first() [2/2]

template<class StoredType, class Allocator>

StoredType & AVector< StoredType, Allocator >::first ( )

inlinenodiscardnoexcept

Sneaky assertions

Container is not empty.

Returns

the first element.

Examples

examples/7guis/cells/src/AST.cpp.

fromRange()

template<class StoredType, class Allocator>

template<aui::incrementable Iterator, aui::invocable< decltype(*std::declval< Iterator >())> UnaryOperation>

static auto AVector< StoredType, Allocator >::fromRange ( aui::range< Iterator > range, UnaryOperation && transformer ) -> AVector<decltype(transformer(range.first()))>

inlinestaticnodiscard

Parameters

range	items to transform from.
transformer	transformer function.

Returns

A new vector.

indexOf()

template<class StoredType, class Allocator>

AOptional< size_t > AVector< StoredType, Allocator >::indexOf ( const StoredType & value ) const

inlinenodiscardnoexcept

Parameters

value

element to find.

Returns

index of the specified element. If element is not found, std::nullopt is returned.

insertAll() [1/4]

template<class StoredType, class Allocator>

template<typename OtherContainer>

iterator AVector< StoredType, Allocator >::insertAll ( const OtherContainer & c )

inlinenoexcept

Inserts all values of the specified container to the end.

Template Parameters

OtherContainer

other container type.

Parameters

c	other container

Returns

iterator pointing to the first element inserted.

insertAll() [2/4]

template<class StoredType, class Allocator>

template<typename OtherContainer>

iterator AVector< StoredType, Allocator >::insertAll ( iterator at, const OtherContainer & c )

inlinenoexcept

Inserts all values of the specified container.

Template Parameters

OtherContainer

other container type.

Parameters

at	position to insert at.
c	other container

Returns

iterator pointing to the first element inserted.

insertAll() [3/4]

template<class StoredType, class Allocator>

template<typename OtherContainer>

iterator AVector< StoredType, Allocator >::insertAll ( iterator at, OtherContainer && c )

inlinenoexcept

Inserts all values of the specified container.

Template Parameters

OtherContainer

other container type.

Parameters

at	position to insert at.
c	other container

Returns

iterator pointing to the first element inserted.

insertAll() [4/4]

template<class StoredType, class Allocator>

template<typename OtherContainer>

iterator AVector< StoredType, Allocator >::insertAll ( OtherContainer && c )

inlinenoexcept

Inserts all values of the specified container to the end.

Template Parameters

OtherContainer

other container type.

Parameters

c	other container

Returns

iterator pointing to the first element inserted.

isSubsetOf()

template<class StoredType, class Allocator>

template<typename OtherContainer>

bool AVector< StoredType, Allocator >::isSubsetOf ( const OtherContainer & c ) const

inlinenoexcept

Returns

true if c container is a subset of this container, false otherwise.

last() [1/2]

template<class StoredType, class Allocator>

const StoredType & AVector< StoredType, Allocator >::last ( ) const

inlinenodiscardnoexcept

Sneaky assertions

Container is not empty.

Returns

the last element.

last() [2/2]

template<class StoredType, class Allocator>

StoredType & AVector< StoredType, Allocator >::last ( )

inlinenodiscardnoexcept

Sneaky assertions

Container is not empty.

Returns

the last element.

Examples

examples/7guis/cells/src/AST.cpp.

operator<<() [1/4]

template<class StoredType, class Allocator>

template<typename OtherContainer, std::enable_if_t<!std::is_convertible_v< OtherContainer, StoredType >, bool > = true>

self & AVector< StoredType, Allocator >::operator<< ( const OtherContainer & c )

inlinenoexcept

Shortcut to insertAll.

Parameters

c	container to push

Returns

self

operator<<() [2/4]

template<class StoredType, class Allocator>

self & AVector< StoredType, Allocator >::operator<< ( const StoredType & rhs )

inlinenoexcept

Shortcut to push_back.

Parameters

rhs	value to push

Returns

self

operator<<() [3/4]

template<class StoredType, class Allocator>

template<typename OtherContainer, std::enable_if_t<!std::is_convertible_v< OtherContainer, StoredType >, bool > = true>

self & AVector< StoredType, Allocator >::operator<< ( OtherContainer && c )

inlinenoexcept

Shortcut to insertAll.

Parameters

c	container to push

Returns

self

operator<<() [4/4]

template<class StoredType, class Allocator>

self & AVector< StoredType, Allocator >::operator<< ( StoredType && rhs )

inlinenoexcept

Shortcut to push_back.

Parameters

rhs	value to push

Returns

self

removeAll() [1/2]

template<class StoredType, class Allocator>

void AVector< StoredType, Allocator >::removeAll ( const StoredType & item )

inlinenoexcept

Removes all occurrences of item.

Parameters

item	element to remove.

removeAll() [2/2]

template<class StoredType, class Allocator>

template<typename T, aui::mapper< const StoredType &, const T & > Projection>

void AVector< StoredType, Allocator >::removeAll ( const T & item, Projection projection )

inlinenoexcept

Removes all occurrences of item with specified projection.

Parameters

item	element to remove.
projection	callable that transforms const StoredType& to const T&. Can be any operator() cappable object, including lambda and pointer-to-member.

removeAt()

template<class StoredType, class Allocator>

void AVector< StoredType, Allocator >::removeAt ( size_t index )

inlinenoexcept

Removes element at the specified index.

Sneaky assertions

index points to the existing element.

Parameters

index

index of the element.

removeFirst()

template<class StoredType, class Allocator>

AOptional< std::size_t > AVector< StoredType, Allocator >::removeFirst ( const StoredType & item )

inlinenoexcept

Removes first occurrence of item.

Parameters

item	element to remove.

Returns

If the item is removed, it's index returned.

removeIf()

template<class StoredType, class Allocator>

template<aui::predicate< StoredType > Predicate>

void AVector< StoredType, Allocator >::removeIf ( Predicate && predicate )

inlinenoexcept

Removes element if predicate(container[i]) == true.

Parameters

predicate

predicate

removeIfFirst()

template<class StoredType, class Allocator>

template<aui::predicate< StoredType > Predicate>

void AVector< StoredType, Allocator >::removeIfFirst ( Predicate && predicate )

inlinenoexcept

Removes only the first element if predicate(container[i]) == true.

Parameters

predicate

predicate

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

View Page SourceEdit Page Source