dmlc::array_view< ValueType > Class Template Reference

Read only data structure to reference continuous memory region of array. Provide unified view for vector, array and C style array. This data structure do not guarantee aliveness of referenced array. More...

#include <array_view.h>

Public Member Functions
	array_view ()=default
	default constructor
	array_view (const array_view< ValueType > &other)=default
	default copy constructor
	array_view (array_view< ValueType > &&other)=default
	default move constructor
array_view< ValueType > &	operator= (const array_view< ValueType > &other)=default
	default assign constructor
	array_view (const std::vector< ValueType > &other)
	construct array view std::vector
template<std::size_t size>
	array_view (const std::array< ValueType, size > &other)
	construct array std::array
	array_view (const ValueType *begin, const ValueType *end)
	construct array view from continuous segment
size_t	size () const
const ValueType *	begin () const
const ValueType *	end () const
const ValueType &	operator[] (size_t i) const
	get i-th element from the view

Detailed Description

template<typename ValueType>
class dmlc::array_view< ValueType >

Read only data structure to reference continuous memory region of array. Provide unified view for vector, array and C style array. This data structure do not guarantee aliveness of referenced array.

Make sure do not use array_view to record data in async function closures. Also do not use array_view to create reference to temporary data structure.

Template Parameters

ValueType

The value

std::vector<int> myvec{1,2,3};
dmlc::array_view<int> view(myvec);
// indexed visit to the view.
LOG(INFO) << view[0];
 
for (int v : view) {
   // visit each element in the view
}

Constructor & Destructor Documentation

array_view() [1/5]

template<typename ValueType >

dmlc::array_view< ValueType >::array_view ( const array_view< ValueType > &  other )

default

default copy constructor

Parameters

other

another array view.

array_view() [2/5]

template<typename ValueType >

dmlc::array_view< ValueType >::array_view ( array_view< ValueType > &&  other )

default

default move constructor

Parameters

other

another array view.

array_view() [3/5]

template<typename ValueType >

dmlc::array_view< ValueType >::array_view ( const std::vector< ValueType > &  other )

inline

construct array view std::vector

Parameters

other

vector container

array_view() [4/5]

template<typename ValueType >

template<std::size_t size>

dmlc::array_view< ValueType >::array_view ( const std::array< ValueType, size > &  other )

inline

construct array std::array

Parameters

other

another array view.

array_view() [5/5]

template<typename ValueType >

dmlc::array_view< ValueType >::array_view ( const ValueType *  begin, const ValueType *  end  )

inline

construct array view from continuous segment

Parameters

begin	beginning pointre
end	end pointer

Member Function Documentation

begin()

template<typename ValueType >

const ValueType * dmlc::array_view< ValueType >::begin ( ) const

inline

Returns

begin of the array

end()

template<typename ValueType >

const ValueType * dmlc::array_view< ValueType >::end ( ) const

inline

Returns

end point of the array

operator=()

template<typename ValueType >

array_view< ValueType > & dmlc::array_view< ValueType >::operator= ( const array_view< ValueType > &  other )

default

default assign constructor

Parameters

other

another array view.

Returns

self.

operator[]()

template<typename ValueType >

const ValueType & dmlc::array_view< ValueType >::operator[] ( size_t  i ) const

inline

get i-th element from the view

Parameters

i	The index.

Returns

const reference to i-th element.

size()

template<typename ValueType >

size_t dmlc::array_view< ValueType >::size ( ) const

inline

Returns

size of the array

---

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

• External/xgboost/dmlc-core/include/dmlc/array_view.h