SumOfGeneralisedObjectiveFunctions.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2005- 2008, Hammersmith Imanet
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_recon_buildblock_SumOfGeneralisedObjectiveFunctions_H__
#define __stir_recon_buildblock_SumOfGeneralisedObjectiveFunctions_H__

#include "stir/shared_ptr.h"
#include "stir/recon_buildblock/GeneralisedObjectiveFunction.h"
#include <vector>

START_NAMESPACE_STIR

template <typename ObjFuncT, typename TargetT, typename ParentT = GeneralisedObjectiveFunction<TargetT>>
class SumOfGeneralisedObjectiveFunctions : public ParentT
{
  typedef ParentT base_type;
  typedef SumOfGeneralisedObjectiveFunctions<ObjFuncT, TargetT, ParentT> self_type;

public:
  inline SumOfGeneralisedObjectiveFunctions();

  template <typename IterT>
  inline SumOfGeneralisedObjectiveFunctions(IterT begin, IterT end);

  inline virtual ~SumOfGeneralisedObjectiveFunctions();

  template <typename IterT>
  inline void set_functions(IterT begin, IterT end);

#if 0

  inline virtual
  TargetT *
    construct_target_ptr() const;
#endif


  inline virtual Succeeded set_up(shared_ptr<TargetT> const& target_sptr);


  inline virtual void
  compute_sub_gradient_without_penalty(TargetT& gradient, const TargetT& current_estimate, const int subset_num);

  inline virtual double actual_compute_objective_function_without_penalty(const TargetT& current_estimate, const int subset_num);


  inline virtual int set_num_subsets(const int num_subsets);

protected:
  typedef std::vector<ObjFuncT> _functions_type;
  typedef typename _functions_type::iterator _functions_iterator_type;
  typedef typename _functions_type::const_iterator _functions_const_iterator_type;
  _functions_type _functions;

  inline virtual bool actual_subsets_are_approximately_balanced(std::string& warning_message) const;
};

END_NAMESPACE_STIR

#include "stir/recon_buildblock/SumOfGeneralisedObjectiveFunctions.inl"

#endif