Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Mantid::API::FunctionDomainGeneral Class Reference

Represent a domain of a very general type. More...

#include <FunctionDomainGeneral.h>

Inheritance diagram for Mantid::API::FunctionDomainGeneral:
Mantid::API::FunctionDomain

Public Member Functions

void addColumn (const std::shared_ptr< Column > &column)
 Add a new column. All columns must have the same size. More...
 
size_t columnCount () const
 Get the number of columns. More...
 
std::shared_ptr< ColumngetColumn (size_t i) const
 Get i-th column. More...
 
size_t size () const override
 Return the number of arguments in the domain. 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

std::vector< std::shared_ptr< Column > > m_columns
 Columns containing function arguments. More...
 

Detailed Description

Represent a domain of a very general type.

Definition at line 21 of file FunctionDomainGeneral.h.

Member Function Documentation

◆ addColumn()

void Mantid::API::FunctionDomainGeneral::addColumn ( const std::shared_ptr< Column > &  column)

Add a new column. All columns must have the same size.

Definition at line 22 of file FunctionDomainGeneral.cpp.

References m_columns, and size().

◆ columnCount()

size_t Mantid::API::FunctionDomainGeneral::columnCount ( ) const

Get the number of columns.

Definition at line 19 of file FunctionDomainGeneral.cpp.

References m_columns.

◆ getColumn()

std::shared_ptr< Column > Mantid::API::FunctionDomainGeneral::getColumn ( size_t  i) const

Get i-th column.

Parameters
i:: Index of a column to get.

Definition at line 36 of file FunctionDomainGeneral.cpp.

References m_columns.

◆ size()

size_t Mantid::API::FunctionDomainGeneral::size ( ) const
overridevirtual

Return the number of arguments in the domain.

Implements Mantid::API::FunctionDomain.

Definition at line 16 of file FunctionDomainGeneral.cpp.

References m_columns.

Referenced by addColumn().

Member Data Documentation

◆ m_columns

std::vector<std::shared_ptr<Column> > Mantid::API::FunctionDomainGeneral::m_columns
private

Columns containing function arguments.

Definition at line 34 of file FunctionDomainGeneral.h.

Referenced by addColumn(), columnCount(), getColumn(), and size().


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