DataVsModelResiduals.h

Go to the documentation of this file.

 
#ifndef MODELFITTING_DATAVSMODELRESIDUALS_H
#define MODELFITTING_DATAVSMODELRESIDUALS_H
 
#include <memory>
#include "ElementsKernel/Exception.h"
#include "ModelFitting/Engine/ResidualBlockProvider.h"
#include "ModelFitting/Engine/DataVsModelInputTraits.h"
 
namespace ModelFitting {

template <typename DataType, typename ModelType, typename WeightType, typename Comparator>
class DataVsModelResiduals : public ResidualBlockProvider {
  
  // The following are just aliases to reduce the typing and make the code
  // more readable
  using DataTraits = DataVsModelInputTraits<DataType>;
  using ModelTraits = DataVsModelInputTraits<ModelType>;
  using WeightTraits = DataVsModelInputTraits<WeightType>;
  
public:
  
  DataVsModelResiduals(DataType data, ModelType model, WeightType weight, Comparator comparator);
  
  virtual ~DataVsModelResiduals();
  
  std::size_t numberOfResiduals() const override;
  
  void populateResidualBlock(IterType output_iter) override;
  
private:
  
  DataType m_data;
  ModelType m_model;
  WeightType m_weight;
  Comparator m_comparator;
  std::size_t m_residual_no;
  
}; // end of class DataVsModelResiduals
 

template <typename DataType, typename ModelType, typename WeightType, typename Comparator>
std::unique_ptr<DataVsModelResiduals<typename std::remove_reference<DataType>::type,
                                     typename std::remove_reference<ModelType>::type,
                                     typename std::remove_reference<WeightType>::type,
                                     typename std::remove_reference<Comparator>::type>
               > createDataVsModelResiduals(DataType&& data, ModelType&& model,
                                            WeightType&& weight, Comparator&& comparator);
 
} // end of namespace ModelFitting
 
#include "_impl/DataVsModelResiduals.icpp"
 
#endif  /* MODELFITTING_DATAVSMODELRESIDUALS_H */