ppforest2 v0.1.0
Projection Pursuit Decision Trees and Random Forests
Loading...
Searching...
No Matches
ppforest2::stats::DataPacket Struct Reference

Bundled dataset: features, response, and group labels. More...

#include <DataPacket.hpp>

Public Member Functions

 DataPacket ()=default
 
 DataPacket (types::FeatureMatrix const &x, types::OutcomeVector const &y, std::set< types::GroupId > const &groups, types::Names const &group_names={}, types::Names const &feature_names={})
 
 DataPacket (types::FeatureMatrix const &x, types::OutcomeVector const &y, types::Names const &group_names={}, types::Names const &feature_names={})
 

Public Attributes

types::Names feature_names
 Original feature column names from the CSV header.
 
types::Names group_names
 Original group label names, indexed by integer code.
 
std::set< types::GroupIdgroups
 Set of distinct group labels (classification only; empty for regression).
 
types::FeatureMatrix x
 Feature matrix (n × p).
 
types::OutcomeVector y
 Response vector (n) — integer labels (classification) or continuous response (regression).
 

Detailed Description

Bundled dataset: features, response, and group labels.

Convenience struct that groups a feature matrix and a response vector with dataset-level metadata (unique group labels, column names). Used primarily for passing data through the training pipeline.

Constructor & Destructor Documentation

◆ DataPacket() [1/3]

ppforest2::stats::DataPacket::DataPacket ( types::FeatureMatrix const & x,
types::OutcomeVector const & y,
std::set< types::GroupId > const & groups,
types::Names const & group_names = {},
types::Names const & feature_names = {} )
inline

◆ DataPacket() [2/3]

ppforest2::stats::DataPacket::DataPacket ( types::FeatureMatrix const & x,
types::OutcomeVector const & y,
types::Names const & group_names = {},
types::Names const & feature_names = {} )
inline

◆ DataPacket() [3/3]

ppforest2::stats::DataPacket::DataPacket ( )
default

Member Data Documentation

◆ feature_names

types::Names ppforest2::stats::DataPacket::feature_names

Original feature column names from the CSV header.

When populated, feature_names[j] is the header label for column j of x. Empty when data is simulated.

◆ group_names

types::Names ppforest2::stats::DataPacket::group_names

Original group label names, indexed by integer code.

When populated, group_names[i] is the original string label that maps to integer code i. Empty when data is not read from CSV (e.g., simulated data) or for regression.

◆ groups

std::set<types::GroupId> ppforest2::stats::DataPacket::groups

Set of distinct group labels (classification only; empty for regression).

◆ x

types::FeatureMatrix ppforest2::stats::DataPacket::x

Feature matrix (n × p).

◆ y

types::OutcomeVector ppforest2::stats::DataPacket::y

Response vector (n) — integer labels (classification) or continuous response (regression).


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