dmlc::Row< IndexType, DType > Class Template Reference

one row of training instance More...

#include <data.h>

Public Member Functions
IndexType	get_field (size_t i) const
IndexType	get_index (size_t i) const
DType	get_value (size_t i) const
DType	get_label () const
real_t	get_weight () const
uint64_t	get_qid () const
template<typename V >
V	SDot (const V *weight, size_t size) const
	helper function to compute dot product of current

Data Fields
const DType *	label
	label of the instance
const real_t *	weight
	weight of the instance
const uint64_t *	qid
	session-id of the instance
size_t	length
	length of the sparse vector
const IndexType *	field
	field of each instance
const IndexType *	index
	index of each instance
const DType *	value
	array value of each instance, this can be NULL indicating every value is set to be 1

Detailed Description

template<typename IndexType, typename DType = real_t>
class dmlc::Row< IndexType, DType >

one row of training instance

Template Parameters

IndexType	type of index
DType	type of data (both label and value will be of DType

Member Function Documentation

get_field()

template<typename IndexType , typename DType = real_t>

IndexType dmlc::Row< IndexType, DType >::get_field ( size_t  i ) const

inline

Parameters

i	the input index

Returns

field for i-th feature

get_index()

template<typename IndexType , typename DType = real_t>

IndexType dmlc::Row< IndexType, DType >::get_index ( size_t  i ) const

inline

Parameters

i	the input index

Returns

i-th feature

get_label()

template<typename IndexType , typename DType = real_t>

DType dmlc::Row< IndexType, DType >::get_label ( ) const

inline

Returns

the label of the instance

get_qid()

template<typename IndexType , typename DType = real_t>

uint64_t dmlc::Row< IndexType, DType >::get_qid ( ) const

inline

Returns

the qid of the instance, this function is always safe even when qid == NULL

get_value()

template<typename IndexType , typename DType = real_t>

DType dmlc::Row< IndexType, DType >::get_value ( size_t  i ) const

inline

Parameters

i	the input index

Returns

i-th feature value, this function is always safe even when value == NULL

get_weight()

template<typename IndexType , typename DType = real_t>

real_t dmlc::Row< IndexType, DType >::get_weight ( ) const

inline

Returns

the weight of the instance, this function is always safe even when weight == NULL

SDot()

template<typename IndexType , typename DType = real_t>

template<typename V >

V dmlc::Row< IndexType, DType >::SDot ( const V *  weight, size_t  size  ) const

inline

helper function to compute dot product of current

Parameters

weight	the dense array of weight we want to product
size	the size of the weight vector

Template Parameters

V	type of the weight vector

Returns

the result of dot product

---

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

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