#include <BLI_generic_array.hh>

Public Member Functions
	GArray (Allocator allocator={}) noexcept
	GArray (NoExceptConstructor, Allocator allocator={}) noexcept
	GArray (const CPPType &type, int64_t size, Allocator allocator={})
	GArray (const CPPType &type, Allocator allocator={})
	GArray (const CPPType &type, void *buffer, int64_t size, Allocator allocator={})
	GArray (const GSpan span, Allocator allocator={})
	GArray (const GArray &other)
	GArray (GArray &&other)
	~GArray ()
GArray &	operator= (const GArray &other)
GArray &	operator= (GArray &&other)
const CPPType &	type () const
bool	is_empty () const
int64_t	size () const
const void *	data () const
void *	data ()
const void *	operator[] (int64_t index) const
void *	operator[] (int64_t index)
	operator GSpan () const
	operator GMutableSpan ()
GSpan	as_span () const
GMutableSpan	as_mutable_span ()
Allocator &	allocator ()
const Allocator &	allocator () const
void	reinitialize (const int64_t new_size)

Protected Attributes
const CPPType *	type_ = nullptr
void *	data_ = nullptr
int64_t	size_ = 0
BLI_NO_UNIQUE_ADDRESS Allocator	allocator_

Detailed Description

template<typename Allocator = GuardedAllocator>
class blender::GArray< Allocator >

Template Parameters

Allocator The allocator used by this array. Should rarely be changed, except when you don't want that MEM_* functions are used internally.

Definition at line 30 of file BLI_generic_array.hh.

Constructor & Destructor Documentation

◆ GArray() [1/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray ( Allocator allocator = {} )

inlinenoexcept

The default constructor creates an empty array, the only situation in which the type is allowed to be null. This default constructor exists so GArray can be used in containers, but the type should be supplied before doing anything else to the array.

Definition at line 46 of file BLI_generic_array.hh.

References allocator().

Referenced by GArray(), GArray(), operator=(), and operator=().

◆ GArray() [2/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray	(	NoExceptConstructor	,
		Allocator	allocator = {} )

inlinenoexcept

Definition at line 48 of file BLI_generic_array.hh.

References allocator().

◆ GArray() [3/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray	(	const CPPType &	type,
		int64_t	size,
		Allocator	allocator = {} )

inline

Create and allocate a new array, with elements default constructed (which does not do anything for trivial types).

Definition at line 54 of file BLI_generic_array.hh.

References allocator(), size(), and type().

◆ GArray() [4/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray	(	const CPPType &	type,
		Allocator	allocator = {} )

inline

Create an empty array with just a type.

Definition at line 65 of file BLI_generic_array.hh.

References allocator(), and type().

◆ GArray() [5/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray	(	const CPPType &	type,
		void *	buffer,
		int64_t	size,
		Allocator	allocator = {} )

inline

Take ownership of a buffer with a provided size. The buffer should be allocated with the same allocator provided to the constructor.

Definition at line 74 of file BLI_generic_array.hh.

References allocator(), size(), and type().

◆ GArray() [6/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray	(	const GSpan	span,
		Allocator	allocator = {} )

inline

Create an array by copying values from a generic span.

Definition at line 88 of file BLI_generic_array.hh.

References allocator().

◆ GArray() [7/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray ( const GArray< Allocator > & other )

inline

Create an array by copying values from another generic array.

Definition at line 97 of file BLI_generic_array.hh.

References allocator(), as_span(), and GArray().

◆ GArray() [8/8]

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::GArray ( GArray< Allocator > && other )

inline

Create an array by taking ownership of another array's data, clearing the data in the other.

Definition at line 102 of file BLI_generic_array.hh.

References allocator_, data_, GArray(), size_, and type_.

◆ ~GArray()

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::~GArray ( )

inline

Definition at line 109 of file BLI_generic_array.hh.

References data_, size_, and type_.

Member Function Documentation

◆ allocator() [1/2]

template<typename Allocator = GuardedAllocator>

Allocator & blender::GArray< Allocator >::allocator ( )

inline

Access the allocator used by this array.

Definition at line 195 of file BLI_generic_array.hh.

References allocator_.

Referenced by GArray(), GArray(), GArray(), GArray(), GArray(), GArray(), and GArray().

◆ allocator() [2/2]

template<typename Allocator = GuardedAllocator>

const Allocator & blender::GArray< Allocator >::allocator ( ) const

inline

Definition at line 199 of file BLI_generic_array.hh.

References allocator_.

◆ as_mutable_span()

template<typename Allocator = GuardedAllocator>

GMutableSpan blender::GArray< Allocator >::as_mutable_span ( )

inline

Definition at line 187 of file BLI_generic_array.hh.

Referenced by blender::bke::EvaluateOnDomainInput::get_varray_for_context(), blender::nodes::node_geo_blur_attribute_cc::BlurAttributeFieldInput::get_varray_for_context(), blender::bke::mesh_apply_spatial_organization(), blender::tests::TEST(), and blender::tests::TEST().

◆ as_span()

template<typename Allocator = GuardedAllocator>

GSpan blender::GArray< Allocator >::as_span ( ) const

inline

Definition at line 182 of file BLI_generic_array.hh.

Referenced by GArray(), blender::nodes::node_geo_blur_attribute_cc::BlurAttributeFieldInput::get_varray_for_context(), blender::bke::mesh_apply_spatial_organization(), blender::tests::TEST(), and blender::tests::TEST().

◆ data() [1/2]

template<typename Allocator = GuardedAllocator>

void * blender::GArray< Allocator >::data ( )

inline

Definition at line 153 of file BLI_generic_array.hh.

References data_.

◆ data() [2/2]

template<typename Allocator = GuardedAllocator>

const void * blender::GArray< Allocator >::data ( ) const

inline

Get a pointer to the beginning of the array.

Definition at line 149 of file BLI_generic_array.hh.

References data_.

Referenced by blender::nodes::node_geo_blur_attribute_cc::BlurAttributeFieldInput::get_varray_for_context(), blender::ed::sculpt_paint::select_grow::select_grow_invoke_per_curve(), blender::tests::TEST(), and blender::tests::TEST().

◆ is_empty()

template<typename Allocator = GuardedAllocator>

bool blender::GArray< Allocator >::is_empty ( ) const

inline

Definition at line 133 of file BLI_generic_array.hh.

References size_.

Referenced by blender::tests::TEST(), and blender::tests::TEST().

◆ operator GMutableSpan()

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::operator GMutableSpan ( )

inline

Definition at line 176 of file BLI_generic_array.hh.

References BLI_assert, data_, size_, and type_.

◆ operator GSpan()

template<typename Allocator = GuardedAllocator>

blender::GArray< Allocator >::operator GSpan ( ) const

inline

Definition at line 170 of file BLI_generic_array.hh.

References BLI_assert, data_, size_, and type_.

◆ operator=() [1/2]

template<typename Allocator = GuardedAllocator>

GArray & blender::GArray< Allocator >::operator= ( const GArray< Allocator > & other )

inline

Definition at line 117 of file BLI_generic_array.hh.

References blender::copy_assign_container(), and GArray().

◆ operator=() [2/2]

template<typename Allocator = GuardedAllocator>

GArray & blender::GArray< Allocator >::operator= ( GArray< Allocator > && other )

inline

Definition at line 122 of file BLI_generic_array.hh.

References GArray(), and blender::move_assign_container().

◆ operator[]() [1/2]

template<typename Allocator = GuardedAllocator>

void * blender::GArray< Allocator >::operator[] ( int64_t index )

inline

Definition at line 164 of file BLI_generic_array.hh.

References BLI_assert, data_, POINTER_OFFSET, size_, and type_.

◆ operator[]() [2/2]

template<typename Allocator = GuardedAllocator>

const void * blender::GArray< Allocator >::operator[] ( int64_t index ) const

inline

Definition at line 158 of file BLI_generic_array.hh.

References BLI_assert, data_, POINTER_OFFSET, size_, and type_.

◆ reinitialize()

template<typename Allocator = GuardedAllocator>

void blender::GArray< Allocator >::reinitialize ( const int64_t new_size )

inline

Destruct values and create a new array of the given size. The values in the new array are default constructed.

Definition at line 208 of file BLI_generic_array.hh.

References BLI_assert, data_, size_, and type_.

◆ size()

template<typename Allocator = GuardedAllocator>

int64_t blender::GArray< Allocator >::size ( ) const

inline

Return the number of elements in the array (not the size in bytes).

Definition at line 141 of file BLI_generic_array.hh.

References size_.

Referenced by GArray(), GArray(), blender::tests::TEST(), and blender::tests::TEST().

◆ type()

template<typename Allocator = GuardedAllocator>

const CPPType & blender::GArray< Allocator >::type ( ) const

inline

Definition at line 127 of file BLI_generic_array.hh.

References BLI_assert, and type_.

Referenced by GArray(), GArray(), GArray(), and blender::tests::TEST().

Member Data Documentation

◆ allocator_

template<typename Allocator = GuardedAllocator>

BLI_NO_UNIQUE_ADDRESS Allocator blender::GArray< Allocator >::allocator_

protected

Definition at line 38 of file BLI_generic_array.hh.

Referenced by allocator(), allocator(), and GArray().

◆ data_

template<typename Allocator = GuardedAllocator>

void* blender::GArray< Allocator >::data_ = nullptr

protected

Definition at line 35 of file BLI_generic_array.hh.

Referenced by data(), data(), GArray(), operator GMutableSpan(), operator GSpan(), operator[](), operator[](), reinitialize(), and ~GArray().

◆ size_

template<typename Allocator = GuardedAllocator>

int64_t blender::GArray< Allocator >::size_ = 0

protected

Definition at line 36 of file BLI_generic_array.hh.

Referenced by GArray(), is_empty(), operator GMutableSpan(), operator GSpan(), operator[](), operator[](), reinitialize(), size(), and ~GArray().

◆ type_

template<typename Allocator = GuardedAllocator>

const CPPType* blender::GArray< Allocator >::type_ = nullptr

protected

The type of the data in the array, will be null after the array is default constructed, but a value should be assigned before any other interaction with the array.

Definition at line 34 of file BLI_generic_array.hh.

Referenced by GArray(), operator GMutableSpan(), operator GSpan(), operator[](), operator[](), reinitialize(), type(), and ~GArray().

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

BLI_generic_array.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GArray() [1/8]

◆ GArray() [2/8]

◆ GArray() [3/8]

◆ GArray() [4/8]

◆ GArray() [5/8]

◆ GArray() [6/8]

◆ GArray() [7/8]

◆ GArray() [8/8]

◆ ~GArray()

Member Function Documentation

◆ allocator() [1/2]

◆ allocator() [2/2]

◆ as_mutable_span()

◆ as_span()

◆ data() [1/2]

◆ data() [2/2]

◆ is_empty()

◆ operator GMutableSpan()

◆ operator GSpan()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ reinitialize()

◆ size()

◆ type()

Member Data Documentation

◆ allocator_

◆ data_

◆ size_

◆ type_