Biomedical Image Analysis Library
The Biomedical Image Analysis Library is a poweful tool for developers, physicians, researchers, engineers, and so on.
Bial::Sample Class Reference

Methods for sampling elements. More...

#include <Sample.hpp>

Collaboration diagram for Bial::Sample:
Collaboration graph

Public Member Functions

 Sample ()
 Basic Constructor. With empty sample vector. More...
 
 Sample (size_t elements)
 Basic Constructor. Initializes vector with a matrix of the number of elements per 1. More...
 
const size_t & operator[] (size_t elm) const
 Returns constant reference to the desired element. The main or first element in that position is returned. More...
 
size_t & operator[] (size_t elm)
 Returns reference to the desired element. The main or first element in that position is returned. More...
 
const size_t & operator() (size_t elm) const
 Returns constant reference to the desired element. The main or first element in that position is returned. More...
 
size_t & operator() (size_t elm)
 Returns reference to the desired element. The main or first element in that position is returned. More...
 
const size_t & operator() (size_t main_elm, size_t repeated_elm) const
 Returns a constant reference to the j-th repeated element of the i-th non-repead element. More...
 
size_t & operator() (size_t main_elm, size_t repeated_elm)
 Returns the reference to the j-th repeated element of the i-th non-repead element. More...
 
size_t Size () const
 Returns the number of non-repeated samples. More...
 
size_t size () const
 Returns the number of non-repeated samples. More...
 
size_t Size (size_t elm) const
 Returns the number of repeated elements to the i-th non-repeated samples. More...
 
size_t size (size_t elm) const
 Returns the number of repeated elements to the i-th non-repeated samples. More...
 
void push_back ()
 Inserts a new entry with no elements. More...
 
void push_back (size_t pos, size_t new_elm)
 Inserts a new element in a given position. More...
 

Detailed Description

Methods for sampling elements.

Definition at line 23 of file Sample.hpp.

Constructor & Destructor Documentation

Bial::Sample::Sample ( )
inline

Basic Constructor. With empty sample vector.

Date
2014/Nov/08
Parameters
none.
Returns
none.
Warning
none.

Definition at line 38 of file Sample.hpp.

Bial::Sample::Sample ( size_t  elements)

Basic Constructor. Initializes vector with a matrix of the number of elements per 1.

Date
2014/Nov/08
Parameters
none.
Returns
none.
Warning
none.

Member Function Documentation

const size_t& Bial::Sample::operator() ( size_t  elm) const

Returns constant reference to the desired element. The main or first element in that position is returned.

Date
2014/Nov/08
Parameters
elmThe element to be accessed.
Returns
Constant reference to the desired element.
Warning
Image bounds are not verified.
size_t& Bial::Sample::operator() ( size_t  elm)

Returns reference to the desired element. The main or first element in that position is returned.

Date
2014/Nov/08
Parameters
elmThe element to be accessed.
Returns
Reference to the desired element.
Warning
Image bounds are not verified.
const size_t& Bial::Sample::operator() ( size_t  main_elm,
size_t  repeated_elm 
) const

Returns a constant reference to the j-th repeated element of the i-th non-repead element.

Date
2014/Nov/08
Parameters
main_elmThe i-th non-repeated element.
repeated_elmThe j-th repeated element of the i-th non-repeated element.
Returns
Constant reference to the j-th repeated element of the i-th non-repead element.
Warning
Image bounds are not verified.
size_t& Bial::Sample::operator() ( size_t  main_elm,
size_t  repeated_elm 
)

Returns the reference to the j-th repeated element of the i-th non-repead element.

Date
2014/Nov/08
Parameters
main_elmThe i-th non-repeated element.
repeated_elmThe j-th repeated element of the i-th non-repeated element.
Returns
The reference to the j-th repeated element of the i-th non-repead element.
Warning
Image bounds are not verified.
const size_t& Bial::Sample::operator[] ( size_t  elm) const

Returns constant reference to the desired element. The main or first element in that position is returned.

Date
2014/Nov/08
Parameters
elmThe element to be accessed.
Returns
Constant reference to the desired element.
Warning
Image bounds are not verified.
size_t& Bial::Sample::operator[] ( size_t  elm)

Returns reference to the desired element. The main or first element in that position is returned.

Date
2014/Nov/08
Parameters
elmThe element to be accessed.
Returns
Reference to the desired element.
Warning
Image bounds are not verified.
void Bial::Sample::push_back ( )

Inserts a new entry with no elements.

Date
2014/Nov/09
Parameters
none.
Returns
none.
Warning
none.
void Bial::Sample::push_back ( size_t  pos,
size_t  new_elm 
)

Inserts a new element in a given position.

Date
2014/Nov/09
Parameters
posThe i-th non-repeated element.
new_elmThe value of new element to be inserted in pos entry.
Returns
none.
Warning
none.
size_t Bial::Sample::Size ( ) const

Returns the number of non-repeated samples.

Date
2014/Nov/09
Parameters
none.
Returns
The number of non-repeated samples.
Warning
none.
size_t Bial::Sample::size ( ) const

Returns the number of non-repeated samples.

Date
2014/Nov/09
Parameters
none.
Returns
The number of non-repeated samples.
Warning
none.
size_t Bial::Sample::Size ( size_t  elm) const

Returns the number of repeated elements to the i-th non-repeated samples.

Date
2014/Nov/09
Parameters
elmThe i-th non-repeated element.
Returns
The number of repeated elements to the i-th non-repeated samples.
Warning
none.
size_t Bial::Sample::size ( size_t  elm) const

Returns the number of repeated elements to the i-th non-repeated samples.

Date
2014/Nov/09
Parameters
elmThe i-th non-repeated element.
Returns
The number of repeated elements to the i-th non-repeated samples.
Warning
none.

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