A generic point-wise image implementation. More...

#include <image.hh>

Inheritance diagram for mln::pw::image< F, S >:

Public Types
typedef S::bkd_piter	bkd_piter
	Backward Site_Iterator associated type.
typedef Image< void >	category
typedef S	domain_t
	Site_Set associated type.
typedef image< F, S >	exact_t
typedef F	function_t
	Function associated type.
typedef S::fwd_piter	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type; default definition is fwd_piter.
typedef S::psite	psite
	Point_Site associated type.
typedef F::result	rvalue
	Return type of read-only access.
typedef S::site	site
	Site associated type.
typedef image< tag::function_ < F >, tag::domain_< S > >	skeleton
	Skeleton.
typedef mln::value::set < F::result >	t_eligible_values_set
	Eligible-value-set associated type.
typedef mln::value::set < typename mln::value::super_value < F::result >::ret >	t_values_space
	Value space associated type.
typedef F::result	value
	Value associated type.
Public Member Functions
void	destroy ()
	Detach data from an image (free it if nobody else hold it).
const S &	domain () const
	Give the definition domain.
F	function () const
	Return the function which computes a site value.
bool	has (const psite &p) const
	Test if `p` belongs to the image domain.
const util::tracked_ptr < internal::data< image< F, S > > > &	hook_data_ () const
	Hook to the image data.
const void *	id_ () const
	Give an identifier of this image.
	image ()
	Constructor without argument.
	image (const Function_v2v< F > &f, const Site_Set< S > &ps)
	Constructor.
unsigned	index_of_point (const P &p) const
	Give the offset of the site `p`.
void	init_ (const Function_v2v< F > &f, const Site_Set< S > &ps)
	Initialize an empty image.
bool	is_valid () const
	Test if this image has been initialized; default impl.
typedef	mlc_if (is_mutable, mutable_result, typename F::result) lvalue
	Return type of read-write access.
std::size_t	nsites () const
	Give the number of sites of the image domain.
rvalue	operator() (const typename S::psite &p) const
	Read-only access of pixel value at point site `p`.
lvalue	operator() (const typename S::psite &p)
	Read-write access returns either a temporary value (copy) or a reference in the case of a mutable function (container).
const t_eligible_values_set &	values_eligible () const
const t_values_space &	values_space () const
	Return the value space of the image.
Protected Attributes
util::tracked_ptr < internal::data< image< F, S > > >	data_
Private Types
typedef pw::internal::image_base< F, S, image< F, S > >	super_

Detailed Description

template<typename F, typename S>
class mln::pw::image< F, S >

A generic point-wise image implementation.

Parameter F is a function restricting the domain. Parameter S is the domain type.

Definition at line 92 of file pw/image.hh.

Member Typedef Documentation

typedef S ::bkd_piter mln::internal::image_base< F::result , S, image< F, S > >::bkd_piter [inherited]

Backward Site_Iterator associated type.

Definition at line 118 of file core/internal/image_base.hh.

typedef Image<void> mln::Image< image< F, S > >::category [inherited]

Reimplemented from mln::Object< image< F, S > >.

Definition at line 75 of file core/concept/image.hh.

typedef S mln::internal::image_base< F::result , S, image< F, S > >::domain_t [inherited]

Site_Set associated type.

Definition at line 105 of file core/internal/image_base.hh.

typedef image< F, S > mln::Object< image< F, S > >::exact_t [inherited]

Definition at line 173 of file object.hh.

typedef F mln::pw::internal::image_base< F, S, image< F, S > >::function_t [inherited]

Function associated type.

Definition at line 122 of file pw/internal/image_base.hh.

typedef S ::fwd_piter mln::internal::image_base< F::result , S, image< F, S > >::fwd_piter [inherited]

Forward Site_Iterator associated type.

Definition at line 115 of file core/internal/image_base.hh.

typedef fwd_piter mln::internal::image_base< F::result , S, image< F, S > >::piter [inherited]

Site_Iterator associated type; default definition is fwd_piter.

Definition at line 123 of file core/internal/image_base.hh.

typedef S ::psite mln::internal::image_base< F::result , S, image< F, S > >::psite [inherited]

Point_Site associated type.

Definition at line 108 of file core/internal/image_base.hh.

typedef F ::result mln::pw::internal::image_base< F, S, image< F, S > >::rvalue [inherited]

Return type of read-only access.

Definition at line 128 of file pw/internal/image_base.hh.

typedef S ::site mln::internal::image_base< F::result , S, image< F, S > >::site [inherited]

Site associated type.

Definition at line 111 of file core/internal/image_base.hh.

template<typename F, typename S>

typedef image< tag::function_<F>, tag::domain_<S> > mln::pw::image< F, S >::skeleton

Skeleton.

Definition at line 99 of file pw/image.hh.

template<typename F, typename S>

typedef pw::internal::image_base< F, S, image<F,S> > mln::pw::image< F, S >::super_ [private]

Definition at line 95 of file pw/image.hh.

typedef mln::value::set<F::result > mln::internal::image_base< F::result , S, image< F, S > >::t_eligible_values_set [inherited]

Eligible-value-set associated type.

Definition at line 91 of file core/internal/image_base.hh.

typedef mln::value::set< typename mln::value::super_value<F::result >::ret > mln::internal::image_base< F::result , S, image< F, S > >::t_values_space [inherited]

Value space associated type.

Definition at line 98 of file core/internal/image_base.hh.

typedef F ::result mln::pw::internal::image_base< F, S, image< F, S > >::value [inherited]

Value associated type.

Reimplemented from mln::internal::image_base< F::result, S, image< F, S > >.

Definition at line 125 of file pw/internal/image_base.hh.

Constructor & Destructor Documentation

template<typename F , typename S >

mln::pw::image< F, S >::image ( ) [inline]

Constructor without argument.

Definition at line 169 of file pw/image.hh.

template<typename F , typename S >

mln::pw::image< F, S >::image	(	const Function_v2v< F > &	f,
		const Site_Set< S > &	ps
	)			`[inline]`

Constructor.

Definition at line 175 of file pw/image.hh.

References mln::internal::image_base< F::result, S, image< F, S > >::data_, and mln::exact().

Member Function Documentation

void mln::internal::image_base< F::result , S, image< F, S > >::destroy ( ) [inherited]

Detach data from an image (free it if nobody else hold it).

const S& mln::pw::internal::image_base< F, S, image< F, S > >::domain ( ) const [inherited]

Give the definition domain.

F mln::pw::internal::image_base< F, S, image< F, S > >::function ( ) const [inherited]

Return the function which computes a site value.

bool mln::internal::image_base< F::result , S, image< F, S > >::has ( const psite & p ) const [inherited]

Test if p belongs to the image domain.

const util::tracked_ptr< internal::data<image< F, S > > >& mln::internal::image_base< F::result , S, image< F, S > >::hook_data_ ( ) const [inherited]

Hook to the image data.

const void* mln::internal::image_base< F::result , S, image< F, S > >::id_ ( ) const [inherited]

Give an identifier of this image.

When several image variables designate the same image, they share the same identifier.

unsigned mln::internal::check::image_fastest_< image< F, S > , mln::metal::equal< mln_trait_image_speed(image< F, S >), trait::image::speed::fastest >::eval >::index_of_point ( const P & p ) const [inherited]

Give the offset of the site p.

Parameters:

[in] p A site.

Warning:: This method is final.

Precondition:: The image has to be initialized and to own the point p.

Postcondition:: p == point_at_index(result)

void mln::pw::internal::image_base< F, S, image< F, S > >::init_	(	const Function_v2v< F > &	f,
		const Site_Set< S > &	ps
	)			`[inherited]`

Initialize an empty image.

Referenced by mln::init_().

bool mln::internal::image_base< F::result , S, image< F, S > >::is_valid ( ) const [inherited]

Test if this image has been initialized; default impl.

typedef mln::pw::internal::image_base< F, S, image< F, S > >::mlc_if	(	is_mutable	,
		mutable_result	,
		typename F::result
	)			`[inherited]`

Return type of read-write access.

std::size_t mln::internal::image_base< F::result , S, image< F, S > >::nsites ( ) const [inherited]

Give the number of sites of the image domain.

rvalue mln::pw::internal::image_base< F, S, image< F, S > >::operator() ( const typename S::psite & p ) const [inherited]

Read-only access of pixel value at point site p.

lvalue mln::pw::internal::image_base< F, S, image< F, S > >::operator() ( const typename S::psite & p ) [inherited]

Read-write access returns either a temporary value (copy) or a reference in the case of a mutable function (container).

const t_eligible_values_set& mln::internal::image_base< F::result , S, image< F, S > >::values_eligible ( ) const [inherited]

const t_values_space& mln::internal::image_base< F::result , S, image< F, S > >::values_space ( ) const [inherited]

Return the value space of the image.

Member Data Documentation

util::tracked_ptr< internal::data<image< F, S > > > mln::internal::image_base< F::result , S, image< F, S > >::data_ [protected, inherited]

Definition at line 163 of file core/internal/image_base.hh.

Referenced by mln::pw::image< F, S >::image().

mln::pw::image< F, S > Class Template Reference [Basic types]

Public Types

Public Member Functions

Protected Attributes

Private Types