Mantid
Loading...
Searching...
No Matches
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
12#include "MantidAPI/IFunction.h"
13#include "MantidKernel/Logger.h"
14
15namespace Mantid {
16namespace API {
17
26class MANTID_API_DLL IFunctionGeneral : public virtual IFunction {
27public:
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
52protected:
54};
55
56} // namespace API
57} // namespace Mantid
Represent a domain of a very general type.
Base class that represents the domain of a function.
A class to store values calculated by a function.
IFunctionGeneral: a very general function definition.
static Kernel::Logger g_log
virtual size_t getNumberDomainColumns() const =0
Get number of columns that the domain must have.
virtual void functionGeneral(const FunctionDomainGeneral &domain, FunctionValues &values) const =0
Provide a concrete function in an implementation that operates on a FunctionDomainGeneral.
virtual size_t getNumberValuesPerArgument() const =0
Get number of values per argument in the domain.
This is an interface to a fitting function - a semi-abstarct class.
Definition: IFunction.h:163
Represents the Jacobian in IFitFunction::functionDeriv.
Definition: Jacobian.h:22
The Logger class is in charge of the publishing messages from the framework through various channels.
Definition: Logger.h:52
Helper class which provides the Collimation Length for SANS instruments.