Mantid
Loading...
Searching...
No Matches
Framework
API
inc
MantidAPI
IFunctionGeneral.h
Go to the documentation of this file.
1
// Mantid Repository : https://github.com/mantidproject/mantid
2
//
3
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
4
// NScD Oak Ridge National Laboratory, European Spallation Source,
5
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6
// SPDX - License - Identifier: GPL - 3.0 +
7
#pragma once
8
9
#include "MantidAPI/DllConfig.h"
10
11
#include "
MantidAPI/FunctionDomainGeneral.h
"
12
#include "
MantidAPI/IFunction.h
"
13
#include "
MantidKernel/Logger.h
"
14
15
namespace
Mantid
{
16
namespace
API
{
17
26
class
MANTID_API_DLL
IFunctionGeneral
:
public
virtual
IFunction
{
27
public
:
28
void
function(
const
FunctionDomain
&domain,
FunctionValues
&values)
const override
;
29
void
functionDeriv(
const
FunctionDomain
&domain,
Jacobian
&jacobian)
override
;
30
31
size_t
getValuesSize(
const
FunctionDomain
&domain)
const override
;
32
35
virtual
void
functionGeneral
(
const
FunctionDomainGeneral
&domain,
FunctionValues
&values)
const
= 0;
36
40
virtual
size_t
getNumberDomainColumns
()
const
= 0;
41
43
virtual
size_t
getNumberValuesPerArgument
()
const
= 0;
44
50
virtual
size_t
getDefaultDomainSize()
const
;
51
52
protected
:
53
static
Kernel::Logger
g_log
;
54
};
55
56
}
// namespace API
57
}
// namespace Mantid
FunctionDomainGeneral.h
IFunction.h
Logger.h
Mantid::API::FunctionDomainGeneral
Represent a domain of a very general type.
Definition:
FunctionDomainGeneral.h:21
Mantid::API::FunctionDomain
Base class that represents the domain of a function.
Definition:
FunctionDomain.h:31
Mantid::API::FunctionValues
A class to store values calculated by a function.
Definition:
FunctionValues.h:25
Mantid::API::IFunctionGeneral
IFunctionGeneral: a very general function definition.
Definition:
IFunctionGeneral.h:26
Mantid::API::IFunctionGeneral::g_log
static Kernel::Logger g_log
Definition:
IFunctionGeneral.h:53
Mantid::API::IFunctionGeneral::getNumberDomainColumns
virtual size_t getNumberDomainColumns() const =0
Get number of columns that the domain must have.
Mantid::API::IFunctionGeneral::functionGeneral
virtual void functionGeneral(const FunctionDomainGeneral &domain, FunctionValues &values) const =0
Provide a concrete function in an implementation that operates on a FunctionDomainGeneral.
Mantid::API::IFunctionGeneral::getNumberValuesPerArgument
virtual size_t getNumberValuesPerArgument() const =0
Get number of values per argument in the domain.
Mantid::API::IFunction
This is an interface to a fitting function - a semi-abstarct class.
Definition:
IFunction.h:163
Mantid::API::Jacobian
Represents the Jacobian in IFitFunction::functionDeriv.
Definition:
Jacobian.h:22
Mantid::Kernel::Logger
The Logger class is in charge of the publishing messages from the framework through various channels.
Definition:
Logger.h:52
API
Definition:
ChudleyElliotSQE.h:16
Mantid
Helper class which provides the Collimation Length for SANS instruments.
Definition:
AbsorptionCorrection.h:18
Generated on Tue Jan 3 2023 11:57:22 for Mantid by
1.9.5