Public Member Functions | Static Public Member Functions
mipa_l2norm_vector_normaliser Class Reference

L2 norm. More...

#include <mipa_l2norm_vector_normaliser.h>

Inheritance diagram for mipa_l2norm_vector_normaliser:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~mipa_l2norm_vector_normaliser ()
virtual void normalise (vnl_vector< double > &sample) const
 Normalise the sample.
virtual vcl_string is_a () const
 Name of the class.
virtual mipa_vector_normaliserclone () const
 Create a copy on the heap and return base class pointer.
virtual void print_summary (vcl_ostream &os) const
 Print class to os.
virtual void b_write (vsl_b_ostream &bfs) const
 Save class to binary file stream.
virtual void b_read (vsl_b_istream &bfs)
 Load class from binary file stream.
virtual void normalise (vnl_vector< double > &sample, unsigned) const
 Normalise the sample, preserving the direction of each nfeatures-sized sub-vector.
virtual void config_from_stream (vcl_istream &is, const mbl_read_props_type &extra_props)
 Initialise from a text stream.

Static Public Member Functions

static vcl_auto_ptr
< mipa_vector_normaliser
new_normaliser_from_stream (vcl_istream &is, const mbl_read_props_type &extra_props)
 Create a concrete mipa_vector_normaliser-derived object, from a text specification.

Detailed Description

L2 norm.

Definition at line 17 of file mipa_l2norm_vector_normaliser.h.


Constructor & Destructor Documentation

virtual mipa_l2norm_vector_normaliser::~mipa_l2norm_vector_normaliser ( ) [inline, virtual]

Definition at line 21 of file mipa_l2norm_vector_normaliser.h.


Member Function Documentation

void mipa_l2norm_vector_normaliser::b_read ( vsl_b_istream bfs) [virtual]

Load class from binary file stream.

Implements mipa_vector_normaliser.

Definition at line 52 of file mipa_l2norm_vector_normaliser.cxx.

void mipa_l2norm_vector_normaliser::b_write ( vsl_b_ostream bfs) const [virtual]

Save class to binary file stream.

Implements mipa_vector_normaliser.

Definition at line 45 of file mipa_l2norm_vector_normaliser.cxx.

mipa_vector_normaliser * mipa_l2norm_vector_normaliser::clone ( ) const [virtual]

Create a copy on the heap and return base class pointer.

Implements mipa_vector_normaliser.

Definition at line 31 of file mipa_l2norm_vector_normaliser.cxx.

void mipa_vector_normaliser::config_from_stream ( vcl_istream &  is,
const mbl_read_props_type extra_props 
) [virtual, inherited]

Initialise from a text stream.

The default implementation is for attribute-less normalisers, and throws if it finds any data in the stream.

Reimplemented in mipa_block_normaliser, and mipa_ms_block_normaliser.

Definition at line 32 of file mipa_vector_normaliser.cxx.

vcl_string mipa_l2norm_vector_normaliser::is_a ( ) const [virtual]

Name of the class.

Implements mipa_vector_normaliser.

Definition at line 25 of file mipa_l2norm_vector_normaliser.cxx.

vcl_auto_ptr< mipa_vector_normaliser > mipa_vector_normaliser::new_normaliser_from_stream ( vcl_istream &  is,
const mbl_read_props_type extra_props 
) [static, inherited]

Create a concrete mipa_vector_normaliser-derived object, from a text specification.

Definition at line 48 of file mipa_vector_normaliser.cxx.

void mipa_l2norm_vector_normaliser::normalise ( vnl_vector< double > &  sample) const [virtual]

Normalise the sample.

Implements mipa_vector_normaliser.

Definition at line 12 of file mipa_l2norm_vector_normaliser.cxx.

virtual void mipa_vector_normaliser::normalise ( vnl_vector< double > &  sample,
unsigned   
) const [inline, virtual, inherited]

Normalise the sample, preserving the direction of each nfeatures-sized sub-vector.

The default implementation assumes that this direction would be preserved anyway.

Definition at line 30 of file mipa_vector_normaliser.h.

void mipa_l2norm_vector_normaliser::print_summary ( vcl_ostream &  os) const [virtual]

Print class to os.

Implements mipa_vector_normaliser.

Definition at line 37 of file mipa_l2norm_vector_normaliser.cxx.


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