Specialization of FunctionDomain1DVector for spectra of MatrixWorkspaces. More...

#include <FunctionDomain1D.h>

Inheritance diagram for Mantid::API::FunctionDomain1DSpectrum:

Public Member Functions
	FunctionDomain1DSpectrum (size_t wi, const std::vector< double > &xvalues)
	Constructor. More...

	FunctionDomain1DSpectrum (size_t wi, std::vector< double >::const_iterator from, std::vector< double >::const_iterator to)
	Constructor. More...

size_t	getWorkspaceIndex () const
	Get the workspace index. More...

Public Member Functions inherited from Mantid::API::FunctionDomain1DVector
	FunctionDomain1DVector (const double startX, const double endX, const size_t n)
	Constructor. More...

	FunctionDomain1DVector (const double x)
	Constructor. More...

	FunctionDomain1DVector (const FunctionDomain1DVector &)
	Copy constructor. More...

	FunctionDomain1DVector (const std::vector< double > &xvalues)
	Constructor. More...

	FunctionDomain1DVector (std::vector< double > &&xvalues)
	No-copy constructor. More...

	FunctionDomain1DVector (std::vector< double >::const_iterator from, std::vector< double >::const_iterator to)
	Constructor. More...

std::vector< double >	getVector ()
	Get the underlying vector. More...

FunctionDomain1DVector &	operator= (const FunctionDomain1DVector &)
	Copy assignment operator. More...

Public Member Functions inherited from Mantid::API::FunctionDomain1D
	FunctionDomain1D (const FunctionDomain1D &right)=delete
	copying is not allowed. More...

int	getPeakRadius () const
	Get the peak radius. More...

const double *	getPointerAt (size_t i) const
	Get a pointer to i-th value. More...

FunctionDomain1D &	operator= (const FunctionDomain1D &)=delete
	copying is not allowed. More...

double	operator[] (size_t i) const
	Get an x value. More...

void	setPeakRadius (int radius)
	Set a peak radius to pass to peak functions. More...

size_t	size () const override
	Return the number of arguments in the domain. More...

std::vector< double >	toVector () const
	Convert to a vector. More...

Public Member Functions inherited from Mantid::API::FunctionDomain
virtual void	reset () const
	Reset the the domain so it can be reused. More...

virtual size_t	size () const =0
	Return the number of points in the domain. More...

virtual	~FunctionDomain ()=default
	Virtual destructor. More...

Private Attributes
size_t	m_workspaceIndex
	The workspace index. More...

Additional Inherited Members
Protected Member Functions inherited from Mantid::API::FunctionDomain1D
	FunctionDomain1D (const double *x, size_t n)
	Protected constructor, shouldn't be created directly. More...

void	resetData (const double *x, size_t n)
	Reset the pointer and size of the domain. More...

Protected Attributes inherited from Mantid::API::FunctionDomain1DVector
std::vector< double >	m_X
	vector of function arguments More...

Detailed Description

Specialization of FunctionDomain1DVector for spectra of MatrixWorkspaces.

The domain holds the workspace index allowing functions to use spectra-specific information.

Definition at line 120 of file FunctionDomain1D.h.

Constructor & Destructor Documentation

◆ FunctionDomain1DSpectrum() [1/2]

Mantid::API::FunctionDomain1DSpectrum::FunctionDomain1DSpectrum	(	size_t	wi,
		const std::vector< double > &	xvalues
	)

Constructor.

Create a domain from a vector.

Parameters

wi	:: The workspace index of a spectrum the xvalues come from.
xvalues	:: Vector with function arguments to be copied from.

Definition at line 139 of file FunctionDomain1D.cpp.

◆ FunctionDomain1DSpectrum() [2/2]

Mantid::API::FunctionDomain1DSpectrum::FunctionDomain1DSpectrum	(	size_t	wi,
		std::vector< double >::const_iterator	from,
		std::vector< double >::const_iterator	to
	)

Constructor.

Create a domain from a part of a vector.

Parameters

wi	:: The workspace index of a spectrum the x-values come from.
from	:: Iterator to start copying values from.
to	:: Iterator to the end of the data.

Definition at line 148 of file FunctionDomain1D.cpp.

Member Function Documentation

◆ getWorkspaceIndex()

size_t Mantid::API::FunctionDomain1DSpectrum::getWorkspaceIndex ( ) const

inline

Get the workspace index.

Definition at line 127 of file FunctionDomain1D.h.

Member Data Documentation

◆ m_workspaceIndex

size_t Mantid::API::FunctionDomain1DSpectrum::m_workspaceIndex

private

The workspace index.

Definition at line 131 of file FunctionDomain1D.h.

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

Framework/API/inc/MantidAPI/FunctionDomain1D.h
Framework/API/src/FunctionDomain1D.cpp

Public Member Functions

Private Attributes

Additional Inherited Members