Public Types | Public Member Functions | Private Attributes | List of all members
ecl::blueprints::ConstantDynamicArray< Type > Class Template Reference

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

#include <array_dynamic_mem_check.hpp>

Public Types

typedef ecl::Array< Type, ecl::DynamicStoragebase_type
 Abstract representation of the class to be instantiated/configured. More...
 
typedef ecl::Array< Type, ecl::DynamicStoragebase_type
 Abstract representation of the class to be instantiated/configured. More...
 

Public Member Functions

void apply (base_type &array) const
 Apply the blueprint to configure an existing object. More...
 
void apply (base_type &array) const
 Apply the blueprint to configure an existing object. More...
 
 ConstantDynamicArray ()
 Default constructor. More...
 
 ConstantDynamicArray ()
 Default constructor. More...
 
 ConstantDynamicArray (size_t size, const Type &value)
 Constructor that properly configures/initialises the blueprint. More...
 
 ConstantDynamicArray (size_t size, const Type &value)
 Constructor that properly configures/initialises the blueprint. More...
 
base_type instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
base_type instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
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 49 of file array_dynamic_mem_check.hpp.

Member Typedef Documentation

◆ base_type [1/2]

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 575 of file array_dynamic_no_mem_check.hpp.

◆ base_type [2/2]

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 696 of file array_dynamic_mem_check.hpp.

Constructor & Destructor Documentation

◆ ConstantDynamicArray() [1/4]

template<typename Type >
ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray ( )
inline

Default constructor.

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

Definition at line 702 of file array_dynamic_mem_check.hpp.

◆ ConstantDynamicArray() [2/4]

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 713 of file array_dynamic_mem_check.hpp.

◆ ~ConstantDynamicArray() [1/2]

template<typename Type >
virtual ecl::blueprints::ConstantDynamicArray< Type >::~ConstantDynamicArray ( )
inlinevirtual

Definition at line 718 of file array_dynamic_mem_check.hpp.

◆ ConstantDynamicArray() [3/4]

template<typename Type >
ecl::blueprints::ConstantDynamicArray< Type >::ConstantDynamicArray ( )
inline

Default constructor.

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

Definition at line 581 of file array_dynamic_no_mem_check.hpp.

◆ ConstantDynamicArray() [4/4]

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 592 of file array_dynamic_no_mem_check.hpp.

◆ ~ConstantDynamicArray() [2/2]

template<typename Type >
virtual ecl::blueprints::ConstantDynamicArray< Type >::~ConstantDynamicArray ( )
inlinevirtual

Definition at line 597 of file array_dynamic_no_mem_check.hpp.

Member Function Documentation

◆ apply() [1/2]

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 623 of file array_dynamic_no_mem_check.hpp.

◆ apply() [2/2]

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 744 of file array_dynamic_mem_check.hpp.

◆ instantiate() [1/2]

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 609 of file array_dynamic_no_mem_check.hpp.

◆ instantiate() [2/2]

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 730 of file array_dynamic_mem_check.hpp.

Member Data Documentation

◆ reserve_size

template<typename Type >
size_t ecl::blueprints::ConstantDynamicArray< Type >::reserve_size
private

Definition at line 750 of file array_dynamic_mem_check.hpp.

◆ val

template<typename Type >
Type ecl::blueprints::ConstantDynamicArray< Type >::val
private

Definition at line 751 of file array_dynamic_mem_check.hpp.


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


ecl_containers
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:14