SerializableObject Class Reference

Inheritance diagram for SerializableObject:

Public Member Functions
virtual int	version () const
	Relevant for serializations.
virtual string	my_class_name () const
	For better handling of serializations it is highly recommended that each SerializableObject inheriting class will implement the next method.
virtual void	serialized_fields_name (vector< string > &field_names) const
	The names of the serialized fields.
virtual void *	new_polymorphic (string derived_name)
	for polymorphic classes that want to be able to serialize/deserialize a pointer * to the derived class given its type one needs to implement this function to return a new to the derived class given its type (as in my_type)
virtual void	pre_serialization ()
virtual void	post_deserialization ()
virtual size_t	get_size ()
	Gets bytes sizes for serializations.
virtual size_t	serialize (unsigned char *blob)
	Serialiazing object to blob memory. return number ob bytes wrote to memory.
virtual size_t	deserialize (unsigned char *blob)
	Deserialiazing blob to object. returns number of bytes read.
size_t	serialize_vec (vector< unsigned char > &blob)
size_t	deserialize_vec (vector< unsigned char > &blob)
virtual size_t	serialize (vector< unsigned char > &blob)
virtual size_t	deserialize (vector< unsigned char > &blob)
virtual int	read_from_file (const string &fname)
	read and deserialize model
virtual int	write_to_file (const string &fname)
	serialize model and write to file
virtual int	read_from_file_unsafe (const string &fname)
	read and deserialize model without checking version number - unsafe read
int	init_from_string (string init_string)
	Init from string.
int	init_params_from_file (string init_file)
int	init_param_from_file (string file_str, string &param)
virtual int	init (map< string, string > &map)
	Virtual to init object from parsed fields.
int	update_from_string (const string &init_string)
virtual int	update (map< string, string > &map)
	Virtual to update object from parsed fields.
virtual string	object_json () const

Member Function Documentation

deserialize()

virtual size_t SerializableObject::deserialize ( unsigned char *  blob )

inlinevirtual

Deserialiazing blob to object. returns number of bytes read.

Reimplemented in MedBooster, MedBP, MedDeepBitParams, MedDeepBit, MedSvm, MedVW, micNet, and MedCleaner.

get_size()

virtual size_t SerializableObject::get_size ( )

inlinevirtual

Gets bytes sizes for serializations.

Reimplemented in MedBooster, MedBP, MedDeepBitParams, MedDeepBit, MedSvm, MedVW, MedCleaner, and micNet.

init()

virtual int SerializableObject::init ( map< string, string > &  map )

inlinevirtual

Virtual to init object from parsed fields.

Reimplemented in KerasLayer, EmbeddingSig, EmbedMatCreator, EmbedTrainCreator, SignalParams, PanelInfo, DrugsHeatMapParams, ChartTimeSign, MedLightGBM, BinSettings, ExplainFilters, ExplainProcessings, ROC_Params, Multiclass_Params, Filter_Param, Gibbs_Params, GibbsSamplingParams, GibbsSampler< T >, GibbsSampler< float >, MedBootstrap, FilterParams, LabelParams, CohortRec, SamplingParams, IncidenceParams, MedRegistryCodesList, MedRegistryCategories, MedRegistryKeepAlive, MedSamplingTimeWindow, MedSamplingAge, MedSamplingDates, MedSamplingFixedTime, MedSamplingYearly, MedSamplingStick, TQRF_Params, TQRF_Forest, Explainer_record_config, Explainer_description_config, Explainer_parameters, InputTesterAttr, InputTesterJsonFeature, MedPredictor, MedBooster, MedLinearModel, MedMicNet, MedPredictorsByMissingValues, MedTQRF, MaskedGANParams, UnivariateSamplesGenerator< T >, MedMutualDist, AggregatePredsPostProcessor, AlcoholGenerator, Calibrator, DiabetesFinderGenerator, DoCalcFeatProcessor, DrugIntakeGenerator, DuplicateProcessor, ElixhauserGenerator, EmbeddingGenerator, ModelExplainer, FairnessPostProcessor, FeatureGenerator, BasicFeatGenerator, AgeGenerator, SingletonGenerator, GenderGenerator, BinnedLmEstimates, RangeFeatGenerator, ModelFeatGenerator, TimeFeatGenerator, AttrFeatGenerator, CategoryDependencyGenerator, FeatureGenExtractTable, FeatureProcessor, MultiFeatureProcessor, FeatureBasicOutlierCleaner, FeatureNormalizer, FeatureImputer, LassoSelector, DgnrtFeatureRemvoer, UnivariateFeatureSelector, MRMRFeatureSelector, TagFeatureSelector, ImportanceFeatureSelector, IterativeFeatureSelector, FeaturePCA, OneHotFeatProcessor, GetProbFeatProcessor, MultiplierProcessor, MissingIndicatorProcessor, Binning_Wrapper, BinningFeatProcessor, IterativeImputerParams, IterativeImputer, FeatureIterativeImputer, KpSmokingGenerator, ChangeModelInfo, PredictorImputer, ProbAdjustPostProcessor, RepCategoryDescenders, RepClearSignalByDiag, RepCreateRegistry, RepFilterByChannel, RepProcessor, RepBasicOutlierCleaner, RepConfiguredOutlierCleaner, RepRuleBasedOutlierCleaner, RepNbrsOutlierCleaner, RepSimValHandler, RepPanelCompleter, SimpleCalculator, RatioCalculator, KfreCalculator, eGFRCalculator, logCalculator, SumCalculator, RangeCalculator, MultiplyCalculator, SetCalculator, ExistsCalculator, ConstantValueCalculator, RepCalcSimpleSignals, RepCombineSignals, RepSplitSignal, RepAggregationPeriod, RepBasicRangeCleaner, RepSignalRate, RepAggregateSignal, RepCreateBitSignal, RepCheckReq, RepHistoryLimit, RepNumericNoiser, RepReoderChannels, ResampleMissingProcessor, SampleFilter, OutlierSampleFilter, MatchingSampleFilter, RequiredSignalFilter, BasicSampleFilter, SmokingGenerator, UnifiedSmokingGenerator, Regression_Params, and RegistrySignal.

my_class_name()

virtual string SerializableObject::my_class_name ( ) const

inlinevirtual

For better handling of serializations it is highly recommended that each SerializableObject inheriting class will implement the next method.

It is a must when one needs to support the new_polymorphic method. One can simply add the macro ADD_CLASS_NAME(class) as a public member in the class.

Reimplemented in MedMat< T >, MedMat< float >, and MedMat< int >.

new_polymorphic()

virtual void * SerializableObject::new_polymorphic ( string  derived_name )

inlinevirtual

for polymorphic classes that want to be able to serialize/deserialize a pointer * to the derived class given its type one needs to implement this function to return a new to the derived class given its type (as in my_type)

Reimplemented in MedPredictor, FeatureGenerator, FeatureProcessor, RepProcessor, SimpleCalculator, SampleFilter, SamplesGenerator< T >, PostProcessor, MedRegistry, and RegistrySignal.

read_from_file()

int SerializableObject::read_from_file ( const string &  fname )

virtual

read and deserialize model

Reimplemented in MedVW.

serialize()

virtual size_t SerializableObject::serialize ( unsigned char *  blob )

inlinevirtual

Serialiazing object to blob memory. return number ob bytes wrote to memory.

Reimplemented in MedBooster, MedBP, MedDeepBitParams, MedDeepBit, MedSvm, MedVW, micNet, and MedCleaner.

serialized_fields_name()

virtual void SerializableObject::serialized_fields_name ( vector< string > &  field_names ) const

inlinevirtual

The names of the serialized fields.

Can be helpful for example to print object fields that can be initialized. can also print helpfull message for init if we keep initialization with the same names.

update()

virtual int SerializableObject::update ( map< string, string > &  map )

inlinevirtual

Virtual to update object from parsed fields.

Reimplemented in ModelExplainer, CategoryDependencyGenerator, and UnifiedSmokingGenerator.

version()

virtual int SerializableObject::version ( ) const

inlinevirtual

Relevant for serializations.

if changing serialization, increase version number for the implementing class

write_to_file()

int SerializableObject::write_to_file ( const string &  fname )

virtual

serialize model and write to file

Reimplemented in MedVW.

---

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

• Internal/SerializableObject/SerializableObject/SerializableObject.h
• Internal/SerializableObject/SerializableObject/SerializableObject.cpp