Turi Create  4.0
turi::v2::ml_data_internal::column_statistics Class Referenceabstract

#include <toolkits/ml_data_2/statistics/column_statistics.hpp>

Public Member Functions

virtual bool is_equal (const column_statistics *other) const =0
 
bool operator== (const column_statistics &other) const
 
bool operator!= (const column_statistics &other) const
 
virtual size_t num_observations () const
 
virtual void initialize ()=0
 Initialize the statistics – counting, mean, and stdev.
 
virtual void update_categorical_statistics (size_t thread_idx, const std::vector< size_t > &cat_index_vect)=0
 Update categorical statistics for a batch of categorical indices.
 
virtual void update_numeric_statistics (size_t thread_idx, const std::vector< double > &value_vect)=0
 Update categorical statistics for a batch of real values.
 
virtual void update_dict_statistics (size_t thread_idx, const std::vector< std::pair< size_t, double > > &dict)=0
 Update statistics after observing a dictionary.
 
virtual void finalize ()=0
 
virtual size_t get_version () const =0
 
virtual void save_impl (turi::oarchive &oarc) const =0
 
virtual void load_version (turi::iarchive &iarc, size_t version)=0
 
virtual void set_data (const std::map< std::string, variant_type > &params)
 
virtual std::shared_ptr< column_statisticscreate_cleared_copy () const =0
 

Static Public Member Functions

static std::shared_ptr< column_statisticsfactory_create (const std::map< std::string, variant_type > &creation_options)
 

Detailed Description

Uses the factory model for saving and loading.

Definition at line 19 of file column_statistics.hpp.

Member Function Documentation

◆ create_cleared_copy()

virtual std::shared_ptr<column_statistics> turi::v2::ml_data_internal::column_statistics::create_cleared_copy ( ) const
pure virtual

Create a copy with the index cleared.

◆ factory_create()

static std::shared_ptr<column_statistics> turi::v2::ml_data_internal::column_statistics::factory_create ( const std::map< std::string, variant_type > &  creation_options)
static

The factory method for loading and instantiating the proper class

◆ finalize()

virtual void turi::v2::ml_data_internal::column_statistics::finalize ( )
pure virtual

Perform final computations on the different statistics. Called after all the data is filled.

Implemented in turi::v2::ml_data_internal::basic_column_statistics.

◆ get_version()

virtual size_t turi::v2::ml_data_internal::column_statistics::get_version ( ) const
pure virtual

Returns the current version used for the serialization.

◆ is_equal()

virtual bool turi::v2::ml_data_internal::column_statistics::is_equal ( const column_statistics other) const
pure virtual

Equality testing in subclass – slow! Use for debugging/testing. Upcast this to superclass to do full testing.

◆ load_version()

virtual void turi::v2::ml_data_internal::column_statistics::load_version ( turi::iarchive iarc,
size_t  version 
)
pure virtual

Load the object.

◆ num_observations()

virtual size_t turi::v2::ml_data_internal::column_statistics::num_observations ( ) const
inlinevirtual

Returns the number of seen by the methods collecting the statistics.

Reimplemented in turi::v2::ml_data_internal::basic_column_statistics.

Definition at line 49 of file column_statistics.hpp.

◆ operator!=()

bool turi::v2::ml_data_internal::column_statistics::operator!= ( const column_statistics other) const

Inequality testing – slow! Use for debugging/testing

◆ operator==()

bool turi::v2::ml_data_internal::column_statistics::operator== ( const column_statistics other) const

Equality testing – slow! Use for debugging/testing

◆ save_impl()

virtual void turi::v2::ml_data_internal::column_statistics::save_impl ( turi::oarchive oarc) const
pure virtual

Serialize the object (save).

◆ set_data()

virtual void turi::v2::ml_data_internal::column_statistics::set_data ( const std::map< std::string, variant_type > &  params)
inlinevirtual

One way to set the statistics. Used by the serialization converters.

Definition at line 122 of file column_statistics.hpp.


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