Represent a mutable reference to an array (0 or more elements consecutively in memory), i.e. More...

#include "llvm/ADT/ArrayRef.h"

Inheritance diagram for llvm::MutableArrayRef< T >:

Public Types
using	value_type = T
using	pointer = value_type *
using	const_pointer = const value_type *
using	reference = value_type &
using	const_reference = const value_type &
using	iterator = pointer
using	const_iterator = const_pointer
using	reverse_iterator = std::reverse_iterator<iterator>
using	const_reverse_iterator = std::reverse_iterator<const_iterator>
using	size_type = size_t
using	difference_type = ptrdiff_t
Public Types inherited from llvm::ArrayRef< T >
using	value_type = T
using	pointer = value_type *
using	const_pointer = const value_type *
using	reference = value_type &
using	const_reference = const value_type &
using	iterator = const_pointer
using	const_iterator = const_pointer
using	reverse_iterator = std::reverse_iterator<iterator>
using	const_reverse_iterator = std::reverse_iterator<const_iterator>
using	size_type = size_t
using	difference_type = ptrdiff_t

Public Member Functions
	MutableArrayRef ()=default
	Construct an empty MutableArrayRef.
	MutableArrayRef (T &OneElt)
	Construct a MutableArrayRef from a single element.
	MutableArrayRef (T *data, size_t length)
	Construct a MutableArrayRef from a pointer and length.
	MutableArrayRef (T begin, T end)
	Construct a MutableArrayRef from a range.
template<typename C, typename = std::enable_if_t< std::conjunction_v< std::is_convertible<decltype(std::declval<C &>().data()) , T const *>, std::is_integral<decltype(std::declval<C &>().size())>>
constexpr	MutableArrayRef (C &&V)
	Construct a MutableArrayRef from a type that has data() and size(), where data() returns a pointer convertible to T const .
template<size_t N>
constexpr	MutableArrayRef (T(&Arr)[N])
	Construct a MutableArrayRef from a C array.
T *	data () const
iterator	begin () const
iterator	end () const
reverse_iterator	rbegin () const
reverse_iterator	rend () const
T &	front () const
	Get the first element.
T &	back () const
	Get the last element.
T &	consume_front ()
	Returns the first element and drops it from ArrayRef.
T &	consume_back ()
	Returns the last element and drops it from ArrayRef.
MutableArrayRef< T >	slice (size_t N, size_t M) const
	Chop off the first `N` elements of the array, and keep `M` elements in the array.
MutableArrayRef< T >	slice (size_t N) const
	Chop off the first `N` elements of the array.
MutableArrayRef< T >	drop_front (size_t N=1) const
	Drop the first `N` elements of the array.
MutableArrayRef< T >	drop_back (size_t N=1) const
template<class PredicateT>
MutableArrayRef< T >	drop_while (PredicateT Pred) const
	Return a copy of *this with the first N elements satisfying the given predicate removed.
template<class PredicateT>
MutableArrayRef< T >	drop_until (PredicateT Pred) const
	Return a copy of *this with the first N elements not satisfying the given predicate removed.
MutableArrayRef< T >	take_front (size_t N=1) const
	Return a copy of *this with only the first `N` elements.
MutableArrayRef< T >	take_back (size_t N=1) const
	Return a copy of *this with only the last `N` elements.
template<class PredicateT>
MutableArrayRef< T >	take_while (PredicateT Pred) const
	Return the first N elements of this Array that satisfy the given predicate.
template<class PredicateT>
MutableArrayRef< T >	take_until (PredicateT Pred) const
	Return the first N elements of this Array that don't satisfy the given predicate.
Operator Overloads
T &	operator[] (size_t Index) const
Public Member Functions inherited from llvm::ArrayRef< T >
	ArrayRef ()=default
	Construct an empty ArrayRef.
	ArrayRef (const T &OneElt LLVM_LIFETIME_BOUND)
	Construct an ArrayRef from a single element.
constexpr	ArrayRef (const T *data LLVM_LIFETIME_BOUND, size_t length)
	Construct an ArrayRef from a pointer and length.
constexpr	ArrayRef (const T begin LLVM_LIFETIME_BOUND, const T end)
	Construct an ArrayRef from a range.
template<typename C, typename = std::enable_if_t< std::conjunction_v< std::is_convertible<decltype(std::declval<const C &>().data()) , const T const *>, std::is_integral<decltype(std::declval<const C &>().size())>>
constexpr	ArrayRef (const C &V)
	Construct an ArrayRef from a type that has a data() method that returns a pointer convertible to const T *.
template<size_t N>
constexpr	ArrayRef (const T(&Arr LLVM_LIFETIME_BOUND)[N])
	Construct an ArrayRef from a C array.
constexpr	ArrayRef (std::initializer_list< T > Vec LLVM_LIFETIME_BOUND)
	Construct an ArrayRef from a std::initializer_list.
template<typename U, typename = std::enable_if_t< std::is_convertible_v<U const , T const >>>
	ArrayRef (const iterator_range< U * > &Range)
	Construct an ArrayRef<T> from iterator_range<U*>.
iterator	begin () const
iterator	end () const
reverse_iterator	rbegin () const
reverse_iterator	rend () const
bool	empty () const
	Check if the array is empty.
const T *	data () const
size_t	size () const
	Get the array size.
const T &	front () const
	Get the first element.
const T &	back () const
	Get the last element.
const T &	consume_front ()
	consume_front() - Returns the first element and drops it from ArrayRef.
const T &	consume_back ()
	consume_back() - Returns the last element and drops it from ArrayRef.
template<typename Allocator>
MutableArrayRef< T >	copy (Allocator &A)
bool	equals (ArrayRef RHS) const
	Check for element-wise equality.
ArrayRef< T >	slice (size_t N, size_t M) const
	slice(n, m) - Chop off the first N elements of the array, and keep M elements in the array.
ArrayRef< T >	slice (size_t N) const
	slice(n) - Chop off the first N elements of the array.
ArrayRef< T >	drop_front (size_t N=1) const
	Drop the first `N` elements of the array.
ArrayRef< T >	drop_back (size_t N=1) const
	Drop the last `N` elements of the array.
template<class PredicateT>
ArrayRef< T >	drop_while (PredicateT Pred) const
	Return a copy of *this with the first N elements satisfying the given predicate removed.
template<class PredicateT>
ArrayRef< T >	drop_until (PredicateT Pred) const
	Return a copy of *this with the first N elements not satisfying the given predicate removed.
ArrayRef< T >	take_front (size_t N=1) const
	Return a copy of *this with only the first `N` elements.
ArrayRef< T >	take_back (size_t N=1) const
	Return a copy of *this with only the last `N` elements.
template<class PredicateT>
ArrayRef< T >	take_while (PredicateT Pred) const
	Return the first N elements of this Array that satisfy the given predicate.
template<class PredicateT>
ArrayRef< T >	take_until (PredicateT Pred) const
	Return the first N elements of this Array that don't satisfy the given predicate.
const T &	operator[] (size_t Index) const
template<typename U>
std::enable_if_t< std::is_same< U, T >::value, ArrayRef< T > > &	operator= (U &&Temporary)=delete
	Disallow accidental assignment from a temporary.
template<typename U>
std::enable_if_t< std::is_same< U, T >::value, ArrayRef< T > > &	operator= (std::initializer_list< U >)=delete
	Disallow accidental assignment from a temporary.
std::vector< T >	vec () const
	operator std::vector< T > () const

Detailed Description

template<typename T>
class llvm::MutableArrayRef< T >

Represent a mutable reference to an array (0 or more elements consecutively in memory), i.e.

a start pointer and a length. It allows various APIs to take and modify consecutive elements easily and conveniently.

This class does not own the underlying data, it is expected to be used in situations where the data resides in some other buffer, whose lifetime extends past that of the MutableArrayRef. For this reason, it is not in general safe to store a MutableArrayRef.

This is intended to be trivially copyable, so it should be passed by value.

Definition at line 294 of file ArrayRef.h.

Member Typedef Documentation

◆ const_iterator

template<typename T>

using llvm::MutableArrayRef< T >::const_iterator = const_pointer

Definition at line 302 of file ArrayRef.h.

◆ const_pointer

template<typename T>

using llvm::MutableArrayRef< T >::const_pointer = const value_type *

Definition at line 298 of file ArrayRef.h.

◆ const_reference

template<typename T>

using llvm::MutableArrayRef< T >::const_reference = const value_type &

Definition at line 300 of file ArrayRef.h.

◆ const_reverse_iterator

template<typename T>

using llvm::MutableArrayRef< T >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 304 of file ArrayRef.h.

◆ difference_type

template<typename T>

using llvm::MutableArrayRef< T >::difference_type = ptrdiff_t

Definition at line 306 of file ArrayRef.h.

◆ iterator

template<typename T>

using llvm::MutableArrayRef< T >::iterator = pointer

Definition at line 301 of file ArrayRef.h.

◆ pointer

template<typename T>

using llvm::MutableArrayRef< T >::pointer = value_type *

Definition at line 297 of file ArrayRef.h.

◆ reference

template<typename T>

using llvm::MutableArrayRef< T >::reference = value_type &

Definition at line 299 of file ArrayRef.h.

◆ reverse_iterator

template<typename T>

using llvm::MutableArrayRef< T >::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 303 of file ArrayRef.h.

◆ size_type

template<typename T>

using llvm::MutableArrayRef< T >::size_type = size_t

Definition at line 305 of file ArrayRef.h.

◆ value_type

template<typename T>

using llvm::MutableArrayRef< T >::value_type = T

Definition at line 296 of file ArrayRef.h.

Constructor & Destructor Documentation

◆ MutableArrayRef() [1/6]

template<typename T>

llvm::MutableArrayRef< T >::MutableArrayRef ( )

default

Construct an empty MutableArrayRef.

◆ MutableArrayRef() [2/6]

template<typename T>

llvm::MutableArrayRef< T >::MutableArrayRef ( T & OneElt )

inline

Construct a MutableArrayRef from a single element.

Definition at line 312 of file ArrayRef.h.

◆ MutableArrayRef() [3/6]

template<typename T>

llvm::MutableArrayRef< T >::MutableArrayRef	(	T *	data,
		size_t	length )

inline

Construct a MutableArrayRef from a pointer and length.

Definition at line 315 of file ArrayRef.h.

◆ MutableArrayRef() [4/6]

template<typename T>

llvm::MutableArrayRef< T >::MutableArrayRef	(	T *	begin,
		T *	end )

inline

Construct a MutableArrayRef from a range.

Definition at line 319 of file ArrayRef.h.

◆ MutableArrayRef() [5/6]

template<typename T>

template<typename C, typename = std::enable_if_t< std::conjunction_v< std::is_convertible<decltype(std::declval<C &>().data()) *, T *const *>, std::is_integral<decltype(std::declval<C &>().size())>>

llvm::MutableArrayRef< T >::MutableArrayRef ( C && V )

inlineconstexpr

Construct a MutableArrayRef from a type that has data() and size(), where data() returns a pointer convertible to T *const *.

Definition at line 330 of file ArrayRef.h.

◆ MutableArrayRef() [6/6]

template<typename T>

template<size_t N>

llvm::MutableArrayRef< T >::MutableArrayRef ( T(&) Arr[N] )

inlineconstexpr

Construct a MutableArrayRef from a C array.

Definition at line 334 of file ArrayRef.h.

Member Function Documentation

◆ back()

template<typename T>

T & llvm::MutableArrayRef< T >::back ( ) const

inline

Get the last element.

Definition at line 351 of file ArrayRef.h.

Referenced by llvm::performOptimizedStructLayout().

◆ begin()

template<typename T>

iterator llvm::MutableArrayRef< T >::begin ( ) const

inline

Definition at line 338 of file ArrayRef.h.

Referenced by combineConcatVectorOfShuffleAndItsOperands(), llvm::lto::findThinLTOModule(), llvm::performOptimizedStructLayout(), llvm::X86FrameLowering::restoreCalleeSavedRegisters(), toUTF8(), and turnVectorIntoSplatVector().

◆ consume_back()

template<typename T>

T & llvm::MutableArrayRef< T >::consume_back ( )

inline

Returns the last element and drops it from ArrayRef.

Definition at line 364 of file ArrayRef.h.

◆ consume_front()

template<typename T>

T & llvm::MutableArrayRef< T >::consume_front ( )

inline

Returns the first element and drops it from ArrayRef.

Definition at line 357 of file ArrayRef.h.

◆ data()

template<typename T>

T * llvm::MutableArrayRef< T >::data ( ) const

inline

Definition at line 336 of file ArrayRef.h.

Referenced by llvm::detail::IEEEFloat::convertToInteger(), llvm::jitlink::LinkGraph::createMutableContentBlock(), llvm::object::Decompressor::decompress(), llvm::jitlink::finalizeBlockRelax(), llvm::pdb::TpiStreamBuilder::finalizeMsfLayout(), getOpenFileImpl(), llvm::performOptimizedStructLayout(), llvm::cas::ondisk::OnDiskKeyValueDB::put(), llvm::jitlink::Block::setMutableContent(), llvm::MCDecodedPseudoProbeInlineTree::setProbes(), llvm::orc::DebugObject::visitSectionLoadAddresses(), llvm::orc::DebugObject::visitSections(), llvm::orc::MachOBuilderDylibLoadCommand< LCType >::write(), llvm::orc::MachOBuilderLoadCommand< MachO::LC_RPATH >::write(), and llvm::MachObjectWriter::writeObject().

◆ drop_back()

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::drop_back ( size_t N = 1 ) const

inline

Definition at line 388 of file ArrayRef.h.

◆ drop_front()

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::drop_front ( size_t N = 1 ) const

inline

Drop the first N elements of the array.

Definition at line 383 of file ArrayRef.h.

Referenced by llvm::AMDGPULegalizerInfo::buildMultiply(), and getOpenFileImpl().

◆ drop_until()

template<typename T>

template<class PredicateT>

MutableArrayRef< T > llvm::MutableArrayRef< T >::drop_until ( PredicateT Pred ) const

inline

Return a copy of *this with the first N elements not satisfying the given predicate removed.

Definition at line 403 of file ArrayRef.h.

◆ drop_while()

template<typename T>

template<class PredicateT>

MutableArrayRef< T > llvm::MutableArrayRef< T >::drop_while ( PredicateT Pred ) const

inline

Return a copy of *this with the first N elements satisfying the given predicate removed.

Definition at line 396 of file ArrayRef.h.

◆ end()

template<typename T>

iterator llvm::MutableArrayRef< T >::end ( ) const

inline

Definition at line 339 of file ArrayRef.h.

Referenced by combineConcatVectorOfShuffleAndItsOperands(), llvm::performOptimizedStructLayout(), llvm::X86FrameLowering::restoreCalleeSavedRegisters(), toUTF8(), and turnVectorIntoSplatVector().

◆ front()

template<typename T>

T & llvm::MutableArrayRef< T >::front ( ) const

inline

Get the first element.

Definition at line 345 of file ArrayRef.h.

◆ operator[]()

template<typename T>

T & llvm::MutableArrayRef< T >::operator[] ( size_t Index ) const

inline

Definition at line 438 of file ArrayRef.h.

◆ rbegin()

template<typename T>

reverse_iterator llvm::MutableArrayRef< T >::rbegin ( ) const

inline

Definition at line 341 of file ArrayRef.h.

◆ rend()

template<typename T>

reverse_iterator llvm::MutableArrayRef< T >::rend ( ) const

inline

Definition at line 342 of file ArrayRef.h.

◆ slice() [1/2]

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::slice ( size_t N ) const

inline

Chop off the first N elements of the array.

Definition at line 378 of file ArrayRef.h.

◆ slice() [2/2]

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::slice	(	size_t	N,
		size_t	M ) const

inline

Chop off the first N elements of the array, and keep M elements in the array.

Definition at line 372 of file ArrayRef.h.

Referenced by llvm::MCFragment::getFixups(), llvm::MCFragment::getVarContents(), llvm::MCFragment::getVarContents(), llvm::MCFragment::getVarFixups(), llvm::insertMultibyteShift(), and multikeySort().

◆ take_back()

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::take_back ( size_t N = 1 ) const

inline

Return a copy of *this with only the last N elements.

Definition at line 415 of file ArrayRef.h.

Referenced by combineConcatVectorOfShuffleAndItsOperands().

◆ take_front()

template<typename T>

MutableArrayRef< T > llvm::MutableArrayRef< T >::take_front ( size_t N = 1 ) const

inline

Return a copy of *this with only the first N elements.

Definition at line 408 of file ArrayRef.h.

Referenced by combineConcatVectorOfShuffleAndItsOperands().

◆ take_until()

template<typename T>

template<class PredicateT>

MutableArrayRef< T > llvm::MutableArrayRef< T >::take_until ( PredicateT Pred ) const

inline

Return the first N elements of this Array that don't satisfy the given predicate.

Definition at line 431 of file ArrayRef.h.

◆ take_while()

template<typename T>

template<class PredicateT>

MutableArrayRef< T > llvm::MutableArrayRef< T >::take_while ( PredicateT Pred ) const

inline

Return the first N elements of this Array that satisfy the given predicate.

Definition at line 424 of file ArrayRef.h.

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

include/llvm/ADT/ArrayRef.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ MutableArrayRef() [1/6]

◆ MutableArrayRef() [2/6]

◆ MutableArrayRef() [3/6]

◆ MutableArrayRef() [4/6]

◆ MutableArrayRef() [5/6]

◆ MutableArrayRef() [6/6]

Member Function Documentation

◆ back()

◆ begin()

◆ consume_back()

◆ consume_front()

◆ data()

◆ drop_back()

◆ drop_front()

◆ drop_until()

◆ drop_while()

◆ end()

◆ front()

◆ operator[]()

◆ rbegin()

◆ rend()

◆ slice() [1/2]

◆ slice() [2/2]

◆ take_back()

◆ take_front()

◆ take_until()

◆ take_while()