ecl::blueprints::ConstantDynamicArray< Type > Class Template Reference

Blueprint for generating a cubic spline satisfying C2 constraints. More...

#include <array_dynamic_mem_check.hpp>

Inheritance diagram for ecl::blueprints::ConstantDynamicArray< Type >:

Public Types
typedef ecl::Array< Type, ecl::DynamicStorage >	base_type
	Abstract representation of the class to be instantiated/configured.
typedef ecl::Array< Type, ecl::DynamicStorage >	base_type
	Abstract representation of the class to be instantiated/configured.
Public Member Functions
void	apply (base_type &array) const
	Apply the blueprint to configure an existing object.
void	apply (base_type &array) const
	Apply the blueprint to configure an existing object.
	ConstantDynamicArray (size_t size, const Type &value)
	Constructor that properly configures/initialises the blueprint.
	ConstantDynamicArray ()
	Default constructor.
	ConstantDynamicArray (size_t size, const Type &value)
	Constructor that properly configures/initialises the blueprint.
	ConstantDynamicArray ()
	Default constructor.
base_type	instantiate ()
	Instantiate a copy of the object that is blueprinted.
base_type	instantiate ()
	Instantiate a copy of the object that is blueprinted.
virtual	~ConstantDynamicArray ()
virtual	~ConstantDynamicArray ()
Private Attributes
size_t	reserve_size
Type	val

Detailed Description

template<typename Type>
class ecl::blueprints::ConstantDynamicArray< Type >

Blueprint for generating a cubic spline satisfying C2 constraints.

Generates a blueprint for creating cubic splines on a set of data satisfying a heuristic that automatically generates y' values at the via points.

Definition at line 674 of file array_dynamic_mem_check.hpp.

Member Typedef Documentation

template<typename Type >

typedef ecl::Array<Type,ecl::DynamicStorage> ecl::blueprints::ConstantDynamicArray< Type >::base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 558 of file array_dynamic_no_mem_check.hpp.

template<typename Type >

typedef ecl::Array<Type,ecl::DynamicStorage> ecl::blueprints::ConstantDynamicArray< Type >::base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 679 of file array_dynamic_mem_check.hpp.

Constructor & Destructor Documentation

template<typename Type >

ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray ( ) [inline]

Default constructor.

Default constructor (only utilised by the blueprint compile time assert).

Definition at line 685 of file array_dynamic_mem_check.hpp.

template<typename Type >

ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray	(	size_t	size,
		const Type &	value
	)			`[inline]`

Constructor that properly configures/initialises the blueprint.

This constructor saves the input parameters to use when generating the instance later.

Parameters:

	size	: the size of the array to create.
	value	: the constant value to fill the array with (defaults to zero).

Definition at line 696 of file array_dynamic_mem_check.hpp.

template<typename Type >

virtual ecl::blueprints::ConstantDynamicArray< Type >::~ConstantDynamicArray ( ) [inline, virtual]

Definition at line 701 of file array_dynamic_mem_check.hpp.

template<typename Type >

ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray ( ) [inline]

Default constructor.

Default constructor (only utilised by the blueprint compile time assert).

Definition at line 564 of file array_dynamic_no_mem_check.hpp.

template<typename Type >

ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray	(	size_t	size,
		const Type &	value
	)			`[inline]`

Constructor that properly configures/initialises the blueprint.

This constructor saves the input parameters to use when generating the instance later.

Parameters:

	size	: the size of the array to create.
	value	: the constant value to fill the array with (defaults to zero).

Definition at line 575 of file array_dynamic_no_mem_check.hpp.

template<typename Type >

virtual ecl::blueprints::ConstantDynamicArray< Type >::~ConstantDynamicArray ( ) [inline, virtual]

Definition at line 580 of file array_dynamic_no_mem_check.hpp.

Member Function Documentation

template<typename Type >

void ecl::blueprints::ConstantDynamicArray< Type >::apply ( base_type & array ) const [inline]

Apply the blueprint to configure an existing object.

Fill all elements of an existing array with a constant value. Note that this clears whatever was initially in the array.

Parameters:

array

: the array to fill.

Definition at line 606 of file array_dynamic_no_mem_check.hpp.

template<typename Type >

void ecl::blueprints::ConstantDynamicArray< Type >::apply ( base_type & array ) const [inline]

Apply the blueprint to configure an existing object.

Fill all elements of an existing array with a constant value. Note that this clears whatever was initially in the array.

Parameters:

array

: the array to fill.

Definition at line 727 of file array_dynamic_mem_check.hpp.

template<typename Type >

base_type ecl::blueprints::ConstantDynamicArray< Type >::instantiate ( ) [inline]

Instantiate a copy of the object that is blueprinted.

Instantiates a new array configured with a constant value. Take care not to use this in assignment, as it will do a costly copy of the entire array. It is, however, fine to use when constructing as the copy constructor will simply use this copy for the constructing object.

Returns:: Array<Type> : a copy of the array.

Definition at line 592 of file array_dynamic_no_mem_check.hpp.

template<typename Type >

base_type ecl::blueprints::ConstantDynamicArray< Type >::instantiate ( ) [inline]

Instantiate a copy of the object that is blueprinted.

Instantiates a new array configured with a constant value. Take care not to use this in assignment, as it will do a costly copy of the entire array. It is, however, fine to use when constructing as the copy constructor will simply use this copy for the constructing object.