Standalone C++ RAII wrapper for Fortran fitpack_grid_sphere. More...

#include <fpGridSphere.hpp>

Inheritance diagram for fpGridSphere:

Collaboration diagram for fpGridSphere:

Public Member Functions
	fpGridSphere ()
	Default constructor - allocates new fitpack_grid_sphere.

	~fpGridSphere () override
	Destructor - deallocates if owned.

	fpGridSphere (const fpGridSphere &other)
	Copy constructor - deep copy.

fpGridSphere &	operator= (const fpGridSphere &other)
	Copy assignment - deep copy.

	fpGridSphere (fpGridSphere &&other) noexcept
	Move constructor - transfer ownership.

fpGridSphere &	operator= (fpGridSphere &&other) noexcept
	Move assignment - transfer ownership.

	fpGridSphere (fitpack_grid_sphere_c &c_wrapper, bool move=false)
	Construct from existing C wrapper (takes ownership if move=true)

	fpGridSphere (fitpack_grid_sphere_c &c_wrapper, ViewTag)
	Non-owning view ctor: bit-copy the C handle, mark is_pointer=true. Used by parent classes' polymorphic accessors to wrap a base-class handle as the correct concrete subtype.

bool	is_allocated () const override
	Check if object is allocated.

bool	is_pointer () const override
	Check if this is a non-owning pointer.

const char *	c_type_name () const override
	Return the C wrapper struct name for this class (e.g. "fitpack_grid_sphere_c").

const char *	cpp_type_name () const override
	Return the fully-qualified C++ class name for this class. Owned by the C++ layer — does not round-trip through Fortran.

fitpack_grid_sphere_c &	c_handle ()
	Get underlying C wrapper (for interop)

const fitpack_grid_sphere_c &	c_handle () const
	Get underlying C wrapper (const, for interop)

fpFitter &	as_parent ()
	Upcast to parent type (reference, no copy)

const fpFitter &	as_parent () const

virtual void	new_points (std::vector< double > &u, std::vector< double > &v, int32_t z_n1, int32_t z_n2, std::vector< double > &z)
	new_points

virtual int32_t	new_fit (std::vector< double > &u, std::vector< double > &v, int32_t z_n1, int32_t z_n2, std::vector< double > &z, double *smoothing=nullptr)
	new_fit

virtual void	BC_north_pole (double z0=nullptr, bool exact=nullptr, bool differentiable=nullptr, bool zero_grad=nullptr)

virtual void	BC_south_pole (double z0=nullptr, bool exact=nullptr, bool differentiable=nullptr, bool zero_grad=nullptr)

virtual int32_t	fit (double smoothing=nullptr, bool keep_knots=nullptr)

virtual int32_t	least_squares (double smoothing=nullptr, bool reset_knots=nullptr)

virtual int32_t	interpolate (bool *reset_knots=nullptr)

virtual double	eval (double u, double v, int32_t *ierr=nullptr)

virtual std::vector< double >	eval (std::vector< double > &u, std::vector< double > &v, int32_t *ierr=nullptr)
	eval

int32_t	comm_size () const override

void	comm_pack (std::vector< double > &buffer) const override
	comm_pack

void	comm_expand (std::vector< double > &buffer) override
	comm_expand

virtual void	write (const char *filename)

double	mse () const override

int32_t	core_comm_size () const override

void	core_comm_pack (std::vector< double > &buffer) const override
	core_comm_pack

void	core_comm_expand (std::vector< double > &buffer) override
	core_comm_expand

void	destroy_base () override

std::vector< double >	u_vector () const
	Deep copy of component 'u' as a std::vector.

fxArray< double >	u () const
	Zero-copy fxArray view of component 'u'.

std::vector< double >	v_vector () const
	Deep copy of component 'v' as a std::vector.

fxArray< double >	v () const
	Zero-copy fxArray view of component 'v'.

std::vector< double >	z_vector () const
	Deep copy of component 'z' as a std::vector.

std::array< int64_t, 2 >	z_shape () const
	Extents of component 'z', leading dimension first.

fxArray< double >	z () const
	Zero-copy fxArray view of component 'z'.

std::vector< double >	t_vector () const
	Deep copy of component 't' as a std::vector.

std::array< int64_t, 2 >	t_shape () const
	Extents of component 't', leading dimension first.

fxArray< double >	t () const
	Zero-copy fxArray view of component 't'.

int32_t &	nmax ()

const int32_t &	nmax () const

Public Member Functions inherited from fpFitter
virtual	~fpFitter ()=default

const char *	fortran_type_name () const
	Return the dynamic Fortran type name of the underlying object.

fitpack_fitter_c &	c_handle ()
	Get underlying C wrapper (for interop)

const fitpack_fitter_c &	c_handle () const
	Get underlying C wrapper (const, for interop)

std::vector< double >	c_vector () const
	Deep copy of component 'c' as a std::vector.

fxArray< double >	c () const
	Zero-copy fxArray view of component 'c'.

std::vector< double >	wrk_vector () const
	Deep copy of component 'wrk' as a std::vector.

fxArray< double >	wrk () const
	Zero-copy fxArray view of component 'wrk'.

std::vector< int32_t >	iwrk_vector () const
	Deep copy of component 'iwrk' as a std::vector.

fxArray< int32_t >	iwrk () const
	Zero-copy fxArray view of component 'iwrk'.

int32_t &	iopt ()

const int32_t &	iopt () const

double &	smoothing ()

const double &	smoothing () const

double &	fp ()

const double &	fp () const

int32_t &	lwrk ()

const int32_t &	lwrk () const

int32_t &	liwrk ()

const int32_t &	liwrk () const

Static Public Member Functions
static fpGridSphere	make_view ()
	Construct an empty (non-owning) wrapper, for use as a view target.

Protected Member Functions
	fpGridSphere (NoAlloc tag)

Protected Member Functions inherited from fpFitter
	fpFitter (NoAlloc)
	Protected constructor for derived classes (does not allocate)

template<typename T>
T *	as ()

template<typename T>
const T *	as () const

Additional Inherited Members
Protected Attributes inherited from fpFitter
fitpack_fitter_c	cobj = fitpack_fitter_c_null

Detailed Description

Standalone C++ RAII wrapper for Fortran fitpack_grid_sphere.

This class provides automatic memory management (RAII) and a natural C++ API for the underlying Fortran fitpack_grid_sphere, without requiring the fortran-arrays library. Array arguments use std::vector<T> for standalone operation. Extends fpFitter (Fortran: extends(fitpack_fitter))

Constructor & Destructor Documentation

◆ fpGridSphere() [1/6]

fpGridSphere::fpGridSphere ( )

inline

Default constructor - allocates new fitpack_grid_sphere.

Here is the call graph for this function:

◆ ~fpGridSphere()

fpGridSphere::~fpGridSphere ( )

inlineoverride

Destructor - deallocates if owned.

Here is the call graph for this function:

◆ fpGridSphere() [2/6]

fpGridSphere::fpGridSphere ( const fpGridSphere & other )

inline

Copy constructor - deep copy.

Here is the call graph for this function:

◆ fpGridSphere() [3/6]

fpGridSphere::fpGridSphere ( fpGridSphere && other )

inlinenoexcept

Move constructor - transfer ownership.

Here is the call graph for this function:

◆ fpGridSphere() [4/6]

fpGridSphere::fpGridSphere	(	fitpack_grid_sphere_c &	c_wrapper,
		bool	move = false )

inlineexplicit

Construct from existing C wrapper (takes ownership if move=true)

Here is the call graph for this function:

◆ fpGridSphere() [5/6]

fpGridSphere::fpGridSphere	(	fitpack_grid_sphere_c &	c_wrapper,
		ViewTag	)

inlineexplicit

Non-owning view ctor: bit-copy the C handle, mark is_pointer=true. Used by parent classes' polymorphic accessors to wrap a base-class handle as the correct concrete subtype.

Here is the call graph for this function:

◆ fpGridSphere() [6/6]

fpGridSphere::fpGridSphere ( NoAlloc tag )

inlineexplicitprotected

Here is the call graph for this function:

Member Function Documentation

◆ as_parent() [1/2]

fpFitter & fpGridSphere::as_parent ( )

inline

Upcast to parent type (reference, no copy)

Here is the call graph for this function:

◆ as_parent() [2/2]

const fpFitter & fpGridSphere::as_parent ( ) const

inline

Here is the call graph for this function:

◆ BC_north_pole()

virtual void fpGridSphere::BC_north_pole	(	double *	z0 = nullptr,
		bool *	exact = nullptr,
		bool *	differentiable = nullptr,
		bool *	zero_grad = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ BC_south_pole()

virtual void fpGridSphere::BC_south_pole	(	double *	z0 = nullptr,
		bool *	exact = nullptr,
		bool *	differentiable = nullptr,
		bool *	zero_grad = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ c_handle() [1/2]

fitpack_grid_sphere_c & fpGridSphere::c_handle ( )

inline

Get underlying C wrapper (for interop)

Here is the call graph for this function:

◆ c_handle() [2/2]

const fitpack_grid_sphere_c & fpGridSphere::c_handle ( ) const

inline

Get underlying C wrapper (const, for interop)

Here is the call graph for this function:

◆ c_type_name()

const char * fpGridSphere::c_type_name ( ) const

inlineoverridevirtual

Return the C wrapper struct name for this class (e.g. "fitpack_grid_sphere_c").

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ comm_expand()

void fpGridSphere::comm_expand ( std::vector< double > & buffer )

inlineoverridevirtual

comm_expand

Implements fpFitter.

Here is the call graph for this function:

◆ comm_pack()

void fpGridSphere::comm_pack ( std::vector< double > & buffer ) const

inlineoverridevirtual

comm_pack

Implements fpFitter.

Here is the call graph for this function:

◆ comm_size()

int32_t fpGridSphere::comm_size ( ) const

inlineoverridevirtual

Implements fpFitter.

Here is the call graph for this function:

◆ core_comm_expand()

void fpGridSphere::core_comm_expand ( std::vector< double > & buffer )

inlineoverridevirtual

core_comm_expand

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ core_comm_pack()

void fpGridSphere::core_comm_pack ( std::vector< double > & buffer ) const

inlineoverridevirtual

core_comm_pack

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ core_comm_size()

int32_t fpGridSphere::core_comm_size ( ) const

inlineoverridevirtual

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ cpp_type_name()

const char * fpGridSphere::cpp_type_name ( ) const

inlineoverridevirtual

Return the fully-qualified C++ class name for this class. Owned by the C++ layer — does not round-trip through Fortran.

Reimplemented from fpFitter.

◆ destroy_base()

void fpGridSphere::destroy_base ( )

inlineoverridevirtual

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ eval() [1/2]

virtual double fpGridSphere::eval	(	double	u,
		double	v,
		int32_t *	ierr = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ eval() [2/2]

virtual std::vector< double > fpGridSphere::eval	(	std::vector< double > &	u,
		std::vector< double > &	v,
		int32_t *	ierr = nullptr )

inlinevirtual

eval

Here is the call graph for this function:

◆ fit()

virtual int32_t fpGridSphere::fit	(	double *	smoothing = nullptr,
		bool *	keep_knots = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ interpolate()

virtual int32_t fpGridSphere::interpolate ( bool * reset_knots = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ is_allocated()

bool fpGridSphere::is_allocated ( ) const

inlineoverridevirtual

Check if object is allocated.

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ is_pointer()

bool fpGridSphere::is_pointer ( ) const

inlineoverridevirtual

Check if this is a non-owning pointer.

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ least_squares()

virtual int32_t fpGridSphere::least_squares	(	double *	smoothing = nullptr,
		bool *	reset_knots = nullptr )

inlinevirtual

Here is the call graph for this function:

◆ make_view()

static fpGridSphere fpGridSphere::make_view ( )

inlinestatic

Construct an empty (non-owning) wrapper, for use as a view target.

The returned object has a null handle (cptr==nullptr, is_pointer==false) and does NOT allocate a Fortran object. Intended as a fill target for member-view accessors emitted on parent types — the parent populates the handle with c_loc() into its own storage and sets is_pointer=true.

Here is the call graph for this function:

◆ mse()

double fpGridSphere::mse ( ) const

inlineoverridevirtual

Reimplemented from fpFitter.

Here is the call graph for this function:

◆ new_fit()

virtual int32_t fpGridSphere::new_fit	(	std::vector< double > &	u,
		std::vector< double > &	v,
		int32_t	z_n1,
		int32_t	z_n2,
		std::vector< double > &	z,
		double *	smoothing = nullptr )

inlinevirtual

new_fit

Here is the call graph for this function:

◆ new_points()

virtual void fpGridSphere::new_points	(	std::vector< double > &	u,
		std::vector< double > &	v,
		int32_t	z_n1,
		int32_t	z_n2,
		std::vector< double > &	z )

inlinevirtual

new_points

Here is the call graph for this function:

◆ nmax() [1/2]

int32_t & fpGridSphere::nmax ( )

inline

Here is the call graph for this function:

◆ nmax() [2/2]

const int32_t & fpGridSphere::nmax ( ) const

inline

Here is the call graph for this function:

◆ operator=() [1/2]

fpGridSphere & fpGridSphere::operator= ( const fpGridSphere & other )

inline

Copy assignment - deep copy.

Here is the call graph for this function:

◆ operator=() [2/2]

fpGridSphere & fpGridSphere::operator= ( fpGridSphere && other )

inlinenoexcept

Move assignment - transfer ownership.

Here is the call graph for this function:

◆ t()

fxArray< double > fpGridSphere::t ( ) const

inline

Zero-copy fxArray view of component 't'.

array_c_from_ptr builds the descriptor from the borrowed pointer and bounds, so the view aliases the Fortran storage directly — nothing is copied and writes through t()(i, j) land in the object.

Note: Only available when the Fortran-Arrays library is present and enabled (HAVE_FXARRAY).

Warning: The view is invalidated by any refit, assignment or destroy call on this object; re-read it rather than retaining it.

Here is the call graph for this function:

◆ t_shape()

std::array< int64_t, 2 > fpGridSphere::t_shape ( ) const

inline

Extents of component 't', leading dimension first.

Returns: All zeros when the component is unallocated.

Here is the call graph for this function:

◆ t_vector()

std::vector< double > fpGridSphere::t_vector ( ) const

inline

Deep copy of component 't' as a std::vector.

The rank-2 component is flattened COLUMN-MAJOR (Fortran order): element (i, j, ...) — zero-based — is at index i + j * extents[0] + ... Query the extents with t_shape().

Returns: An owning copy, empty when the component is unallocated.

Here is the call graph for this function:

◆ u()

fxArray< double > fpGridSphere::u ( ) const

inline

Zero-copy fxArray view of component 'u'.

array_c_from_ptr builds the descriptor from the borrowed pointer and bounds, so the view aliases the Fortran storage directly — nothing is copied and writes through u()(i) land in the object.

Note: Only available when the Fortran-Arrays library is present and enabled (HAVE_FXARRAY).

Warning: The view is invalidated by any refit, assignment or destroy call on this object; re-read it rather than retaining it.

Here is the call graph for this function:

◆ u_vector()

std::vector< double > fpGridSphere::u_vector ( ) const

inline

Deep copy of component 'u' as a std::vector.

Returns: An owning copy, empty when the component is unallocated.

Here is the call graph for this function:

◆ v()

fxArray< double > fpGridSphere::v ( ) const

inline

Zero-copy fxArray view of component 'v'.

array_c_from_ptr builds the descriptor from the borrowed pointer and bounds, so the view aliases the Fortran storage directly — nothing is copied and writes through v()(i) land in the object.

Note: Only available when the Fortran-Arrays library is present and enabled (HAVE_FXARRAY).

Warning: The view is invalidated by any refit, assignment or destroy call on this object; re-read it rather than retaining it.

Here is the call graph for this function:

◆ v_vector()

std::vector< double > fpGridSphere::v_vector ( ) const

inline

Deep copy of component 'v' as a std::vector.

Returns: An owning copy, empty when the component is unallocated.

Here is the call graph for this function:

◆ write()

virtual void fpGridSphere::write ( const char * filename )

inlinevirtual

Here is the call graph for this function:

◆ z()

fxArray< double > fpGridSphere::z ( ) const

inline

Zero-copy fxArray view of component 'z'.

array_c_from_ptr builds the descriptor from the borrowed pointer and bounds, so the view aliases the Fortran storage directly — nothing is copied and writes through z()(i, j) land in the object.

Note: Only available when the Fortran-Arrays library is present and enabled (HAVE_FXARRAY).

Warning: The view is invalidated by any refit, assignment or destroy call on this object; re-read it rather than retaining it.

Here is the call graph for this function:

◆ z_shape()

std::array< int64_t, 2 > fpGridSphere::z_shape ( ) const

inline

Extents of component 'z', leading dimension first.

Returns: All zeros when the component is unallocated.

Here is the call graph for this function:

◆ z_vector()

std::vector< double > fpGridSphere::z_vector ( ) const

inline

Deep copy of component 'z' as a std::vector.

The rank-2 component is flattened COLUMN-MAJOR (Fortran order): element (i, j, ...) — zero-based — is at index i + j * extents[0] + ... Query the extents with z_shape().

Returns: An owning copy, empty when the component is unallocated.

Here is the call graph for this function:

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

fpGridSphere.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fpGridSphere() [1/6]

◆ ~fpGridSphere()

◆ fpGridSphere() [2/6]

◆ fpGridSphere() [3/6]

◆ fpGridSphere() [4/6]

◆ fpGridSphere() [5/6]

◆ fpGridSphere() [6/6]

Member Function Documentation

◆ as_parent() [1/2]

◆ as_parent() [2/2]

◆ BC_north_pole()

◆ BC_south_pole()

◆ c_handle() [1/2]

◆ c_handle() [2/2]

◆ c_type_name()

◆ comm_expand()

◆ comm_pack()

◆ comm_size()

◆ core_comm_expand()

◆ core_comm_pack()

◆ core_comm_size()

◆ cpp_type_name()

◆ destroy_base()

◆ eval() [1/2]

◆ eval() [2/2]

◆ fit()

◆ interpolate()

◆ is_allocated()

◆ is_pointer()

◆ least_squares()

◆ make_view()

◆ mse()

◆ new_fit()

◆ new_points()

◆ nmax() [1/2]

◆ nmax() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ t()

◆ t_shape()

◆ t_vector()

◆ u()

◆ u_vector()

◆ v()

◆ v_vector()

◆ write()

◆ z()

◆ z_shape()

◆ z_vector()