CompositeFunction.cpp 31 KB
Newer Older
1
2
3
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
4
5
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6
// SPDX - License - Identifier: GPL - 3.0 +
7
8
9
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
10
#include "MantidAPI/CompositeFunction.h"
11
#include "MantidAPI/FunctionFactory.h"
LamarMoore's avatar
LamarMoore committed
12
13
#include "MantidAPI/IConstraint.h"
#include "MantidAPI/ParameterTie.h"
Gigg, Martyn Anthony's avatar
Gigg, Martyn Anthony committed
14
15
#include "MantidKernel/Exception.h"
#include "MantidKernel/Logger.h"
16
#include "MantidKernel/Strings.h"
Gigg, Martyn Anthony's avatar
Gigg, Martyn Anthony committed
17

LamarMoore's avatar
LamarMoore committed
18
#include <algorithm>
19
#include <boost/lexical_cast.hpp>
20
#include <memory>
21
#include <sstream>
David Fairbrother's avatar
David Fairbrother committed
22
#include <utility>
23

24
25
namespace Mantid {
namespace API {
26

27
28
29
namespace {
/// static logger
Kernel::Logger g_log("CompositeFunction");
30
constexpr char *ATTNUMDERIV = "NumDeriv";
31
constexpr int NUMDEFAULTATTRIBUTES = 1;
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
template <typename T>
void replaceVariableIndexRange(std::vector<T> &variableFunctionIndexList,
                               size_t oldSize, size_t newSize,
                               const T functionIndex) {
  auto itFun = std::find(variableFunctionIndexList.begin(),
                         variableFunctionIndexList.end(), functionIndex);
  if (itFun != variableFunctionIndexList.end()) {
    if (oldSize > newSize) {
      variableFunctionIndexList.erase(itFun, itFun + oldSize - newSize);
    } else if (oldSize < newSize) {
      variableFunctionIndexList.insert(itFun, newSize - oldSize, functionIndex);
    }
  } else if (newSize > 0) {
    using std::placeholders::_1;
    itFun = std::find_if(variableFunctionIndexList.begin(),
                         variableFunctionIndexList.end(),
                         std::bind(std::greater<size_t>(), _1, functionIndex));
    variableFunctionIndexList.insert(itFun, newSize, functionIndex);
  }
}

LamarMoore's avatar
LamarMoore committed
53
} // namespace
Gigg, Martyn Anthony's avatar
Gigg, Martyn Anthony committed
54

Peterson, Peter's avatar
Peterson, Peter committed
55
56
using std::size_t;

57
DECLARE_FUNCTION(CompositeFunction)
58

59
/// Default constructor
60
CompositeFunction::CompositeFunction()
61
62
    : IFunction(), m_nParams(0), m_nAttributes(0),
      m_iConstraintFunction(false) {
63
  createDefaultGlobalAttributes();
Stephen's avatar
Stephen committed
64
65
}

66
67
void CompositeFunction::createDefaultGlobalAttributes() {
  m_globalAttributeNames.clear();
68
  declareAttribute(ATTNUMDERIV, Attribute(false));
69
  m_nAttributes = NUMDEFAULTATTRIBUTES;
70
71
}

72
/// Function initialization. Declare function parameters in this method.
73
void CompositeFunction::init() {}
74

75
/**
76
77
78
 * Writes itself into a string. Functions derived from CompositeFunction may
 * need to override this method with something like this:
 *   std::string NewFunction::writeToString()const
79
80
81
82
83
84
85
 *   {
 *      ostr << "composite=" << this->name() << ';';
 *      // write NewFunction's own attributes and parameters
 *      ostr << CompositeFunction::asString();
 *      // write NewFunction's own ties and constraints
 *      // ostr << ";constraints=(" << ... <<")";
 *   }
Roman Tolchenov's avatar
Roman Tolchenov committed
86
87
 * @param parentLocalAttributesStr :: A preformatted string with parent's local
 * attributes.
88
 *    Can be passed in by a CompositeFunction (eg MultiDomainFunction).
89
 * @return the string representation of the composite function
90
 */
Roman Tolchenov's avatar
Roman Tolchenov committed
91
92
std::string CompositeFunction::writeToString(
    const std::string &parentLocalAttributesStr) const {
93
  std::ostringstream ostr;
94

95
  // if empty just return function name
96
  if (nFunctions() == 0) {
97
98
99
    return "name=" + name();
  }

100
101
  if (name() != "CompositeFunction" ||
      nGlobalAttributes() > NUMDEFAULTATTRIBUTES ||
102
      getAttribute(ATTNUMDERIV).asBool() || !parentLocalAttributesStr.empty()) {
103
    ostr << "composite=" << name();
Stephen's avatar
Stephen committed
104
    std::vector<std::string> attr = m_globalAttributeNames;
105
106
    for (const auto &attName : attr) {
      std::string attValue = this->getAttribute(attName).value();
107
108
      if (!attValue.empty()) {
        ostr << ',' << attName << '=' << attValue;
109
110
      }
    }
111
    ostr << parentLocalAttributesStr << ';';
112
  }
113
  const auto localAttr = this->getLocalAttributeNames();
114
  for (size_t i = 0; i < nFunctions(); i++) {
115
    IFunction_sptr fun = getFunction(i);
116
    bool isComp = std::dynamic_pointer_cast<CompositeFunction>(fun) != nullptr;
117
118
    if (isComp)
      ostr << '(';
119
    std::ostringstream localAttributesStr;
120
121
122
123
124
    for (const auto &localAttName : localAttr) {
      const std::string localAttValue =
          this->getLocalAttribute(i, localAttName).value();
      if (!localAttValue.empty()) {
        // local attribute names are prefixed by dollar sign
Roman Tolchenov's avatar
Roman Tolchenov committed
125
126
        localAttributesStr << ',' << '$' << localAttName << '='
                           << localAttValue;
127
128
      }
    }
129
    ostr << fun->writeToString(localAttributesStr.str());
130
131
132
    if (isComp)
      ostr << ')';
    if (i < nFunctions() - 1) {
133
134
135
      ostr << ';';
    }
  }
136
137
138
139
140
141

  // collect non-default constraints
  std::string constraints = writeConstraints();
  // print constraints
  if (!constraints.empty()) {
    ostr << ";constraints=(" << constraints << ")";
142
  }
143
144
145
146

  // collect the non-default ties
  std::string ties = writeTies();
  // print the ties
147
  if (!ties.empty()) {
148
    ostr << ";ties=(" << ties << ")";
149
  }
150

151
152
153
  return ostr.str();
}

154
155
156
/**
 * @param ws A pointer to the workspace being fitted
 */
157
void CompositeFunction::setWorkspace(std::shared_ptr<const Workspace> ws) {
158
159
  // Pass it on to each member
  auto iend = m_functions.end();
160
  for (auto it = m_functions.begin(); it != iend; ++it) {
161
162
163
164
    (*it)->setWorkspace(ws);
  }
}

165
166
167
168
169
170
/**
 * @param workspace :: A workspace to fit to.
 * @param wi :: An index of a spectrum to fit to.
 * @param startX :: A start of the fitting region.
 * @param endX :: An end of the fitting region.
 */
171
void CompositeFunction::setMatrixWorkspace(
172
173
    std::shared_ptr<const MatrixWorkspace> workspace, size_t wi, double startX,
    double endX) {
174
175
176
  for (size_t iFun = 0; iFun < nFunctions(); ++iFun) {
    m_functions[iFun]->setMatrixWorkspace(workspace, wi, startX, endX);
  }
177
178
}

179
/** Function you want to fit to.
180
 *  @param domain :: An instance of FunctionDomain with the function arguments.
181
182
 *  @param values :: A FunctionValues instance for storing the calculated
 * values.
183
 */
184
185
void CompositeFunction::function(const FunctionDomain &domain,
                                 FunctionValues &values) const {
186
  FunctionValues tmp(domain);
187
  values.zeroCalculated();
188
189
  for (size_t iFun = 0; iFun < nFunctions(); ++iFun) {
    m_functions[iFun]->function(domain, tmp);
190
191
192
193
194
195
196
197
198
    values += tmp;
  }
}

/**
 * Derivatives of function with respect to active parameters
 * @param domain :: Function domain to get the arguments from.
 * @param jacobian :: A Jacobian to store the derivatives.
 */
199
200
void CompositeFunction::functionDeriv(const FunctionDomain &domain,
                                      Jacobian &jacobian) {
201
  if (getAttribute(ATTNUMDERIV).asBool()) {
202
    calNumericalDeriv(domain, jacobian);
203
204
205
206
  } else {
    for (size_t iFun = 0; iFun < nFunctions(); ++iFun) {
      PartialJacobian J(&jacobian, paramOffset(iFun));
      getFunction(iFun)->functionDeriv(domain, J);
207
    }
208
209
210
  }
}

211
/** Sets a new value to the i-th parameter.
212
213
 *  @param i :: The parameter index
 *  @param value :: The new value
214
215
 *  @param explicitlySet :: A boolean falgging the parameter as explicitly set
 * (by user)
216
 */
217
218
void CompositeFunction::setParameter(size_t i, const double &value,
                                     bool explicitlySet) {
219
  size_t iFun = functionIndex(i);
220
221
  m_functions[iFun]->setParameter(i - m_paramOffsets[iFun], value,
                                  explicitlySet);
222
223
}

224
225
226
227
/** Sets a new description to the i-th parameter.
 *  @param i :: The parameter index
 *  @param description :: The new description
 */
228
229
void CompositeFunction::setParameterDescription(
    size_t i, const std::string &description) {
230
  size_t iFun = functionIndex(i);
231
232
  m_functions[iFun]->setParameterDescription(i - m_paramOffsets[iFun],
                                             description);
233
234
}

235
/** Get the i-th parameter.
236
 *  @param i :: The parameter index
237
 *  @return value of the requested parameter
238
 */
239
double CompositeFunction::getParameter(size_t i) const {
Peterson, Peter's avatar
Peterson, Peter committed
240
  size_t iFun = functionIndex(i);
241
  return m_functions[iFun]->getParameter(i - m_paramOffsets[iFun]);
242
243
}

244
245
246
247
/**
 * Check if function has a parameter with a particular name.
 * @param name :: A name of a parameter.
 * @return True if the parameter exists.
LamarMoore's avatar
LamarMoore committed
248
 */
249
250
bool CompositeFunction::hasParameter(const std::string &name) const {
  try {
251
252
253
254
    auto [parameterName, index] = parseName(name);
    return index < m_functions.size()
               ? m_functions[index]->hasParameter(parameterName)
               : false;
255
256
257
258
259
  } catch (std::invalid_argument &) {
    return false;
  }
}

Stephen's avatar
Stephen committed
260
261
262
263
264
265
266
267
268
269
270
271
/**
 * Check if function has a attribute with a particular name.
 * @param name :: A name of a attribute.
 * @return True if the parameter exists.
 */
bool CompositeFunction::hasAttribute(const std::string &name) const {
  try {
    if (std::find(m_globalAttributeNames.begin(), m_globalAttributeNames.end(),
                  name) != m_globalAttributeNames.end()) {
      return true;
    }
    auto [attributeName, index] = parseName(name);
272
273
    return m_functions[index]->hasAttribute(attributeName);
  } catch (...) {
Stephen's avatar
Stephen committed
274
275
276
277
    return false;
  }
}

278
279
/**
 * Sets a new value to a parameter by name.
280
281
 * @param name :: The name of the parameter.
 * @param value :: The new value
282
 * @param explicitlySet :: A boolean flagging the parameter as explicitly set
283
 * (by user)
284
 */
285
286
void CompositeFunction::setParameter(const std::string &name,
                                     const double &value, bool explicitlySet) {
287
288
  auto [parameterName, index] = parseName(name);
  getFunction(index)->setParameter(parameterName, value, explicitlySet);
289
290
}

291
292
293
/**
 * Sets a new description to a parameter by name.
 * @param name :: The name of the parameter.
294
 * @param description :: The new description
295
 */
296
297
void CompositeFunction::setParameterDescription(
    const std::string &name, const std::string &description) {
298
299
  auto [parameterName, index] = parseName(name);
  getFunction(index)->setParameterDescription(parameterName, description);
300
301
}

302
303
/**
 * Parameters by name.
304
 * @param name :: The name of the parameter.
305
 * @return value of the requested named parameter
306
 */
307
double CompositeFunction::getParameter(const std::string &name) const {
308
309
  auto [parameterName, index] = parseName(name);
  return getFunction(index)->getParameter(parameterName);
310
311
}

312
313
314
315
316
317
318
319
320
321
322
323
324
/**
 * Return a value of attribute attName
 * @param name :: Returns the named attribute
 */
API::IFunction::Attribute
CompositeFunction::getAttribute(const std::string &name) const {
  try {
    if (std::find(m_globalAttributeNames.begin(), m_globalAttributeNames.end(),
                  name) != m_globalAttributeNames.end()) {
      return IFunction::getAttribute(name);
    }
    auto [attributeName, index] = parseName(name);
    return m_functions[index]->getAttribute(attributeName);
325
  } catch (std::invalid_argument &) {
326
327
328
329
330
331
    throw std::invalid_argument(
        "ParamFunctionAttributeHolder::getAttribute - Unknown attribute '" +
        name + "'");
  }
}

332
/**
Stephen's avatar
Stephen committed
333
 *  Set a value of a named attribute.
334
335
336
337
338
339
340
341
342
343
344
345
346
 *  @param name :: The name of the attribute
 *  @param value :: The value of the attribute
 */
void CompositeFunction::setAttribute(const std::string &name,
                                     const API::IFunction::Attribute &value) {
  if (std::find(m_globalAttributeNames.begin(), m_globalAttributeNames.end(),
                name) != m_globalAttributeNames.end()) {
    return IFunction::setAttribute(name, value);
  }
  auto [attributeName, index] = parseName(name);
  return m_functions[index]->setAttribute(attributeName, value);
}

347
/// Total number of parameters
348
size_t CompositeFunction::nParams() const { return m_nParams; }
349

350
// Total number of attributes
351
352
353
354
355
356
357
size_t CompositeFunction::nAttributes() const {
  size_t numAttributes = nGlobalAttributes();
  for (const auto &func : m_functions) {
    numAttributes += func->nAttributes();
  }
  return numAttributes;
}
358
/**
359
 *
360
 * @param name :: The name of a parameter
361
 * @return index of the requested named parameter
362
 */
363
size_t CompositeFunction::parameterIndex(const std::string &name) const {
364
365
366
  auto [parameterName, index] = parseName(name);
  return getFunction(index)->parameterIndex(parameterName) +
         m_paramOffsets[index];
367
368
}

Nick Draper's avatar
re #100    
Nick Draper committed
369
/// Returns the name of parameter
370
/// @param i :: The index
Nick Draper's avatar
re #100    
Nick Draper committed
371
/// @return The name of the parameter
372
std::string CompositeFunction::parameterName(size_t i) const {
373
  size_t iFun = functionIndex(i);
374
  std::ostringstream ostr;
375
376
  ostr << 'f' << iFun << '.'
       << m_functions[iFun]->parameterName(i - m_paramOffsets[iFun]);
377
  return ostr.str();
378
379
}

380
381
382
383
/// Returns the name of the ith attribute
/// @param index :: The index of the attribute
/// @return The name of the attribute
std::string CompositeFunction::attributeName(size_t index) const {
384
  if (index < nGlobalAttributes())
Stephen's avatar
Stephen committed
385
    return IFunction::attributeName(index);
386
387
388
389

  // Offset the index by the number of global attributes
  auto offsetIndex = index - nGlobalAttributes();
  size_t functionIndex = attributeFunctionIndex(offsetIndex);
390
391
  std::ostringstream ostr;
  ostr << 'f' << functionIndex << '.'
Stephen's avatar
Stephen committed
392
       << m_functions[functionIndex]->attributeName(
393
              getAttributeOffset(offsetIndex));
394
395
396
  return ostr.str();
}

397
398
399
/// Returns the description of parameter
/// @param i :: The index
/// @return The description of the parameter
400
std::string CompositeFunction::parameterDescription(size_t i) const {
401
  size_t iFun = functionIndex(i);
402
  std::ostringstream ostr;
403
  ostr << m_functions[iFun]->parameterDescription(i - m_paramOffsets[iFun]);
404
405
  return ostr.str();
}
406
/**
407
408
409
410
 * Get the fitting error for a parameter
 * @param i :: The index of a parameter
 * @return :: the error
 */
411
double CompositeFunction::getError(size_t i) const {
412
  size_t iFun = functionIndex(i);
413
  return m_functions[iFun]->getError(i - m_paramOffsets[iFun]);
414
415
}

416
/**
417
418
419
420
 * Set the fitting error for a parameter
 * @param i :: The index of a parameter
 * @param err :: The error value to set
 */
421
void CompositeFunction::setError(size_t i, double err) {
422
  size_t iFun = functionIndex(i);
423
  m_functions[iFun]->setError(i - m_paramOffsets[iFun], err);
424
425
}

426
427
428
/// Value of i-th active parameter. Override this method to make fitted
/// parameters different from the declared
double CompositeFunction::activeParameter(size_t i) const {
429
  size_t iFun = functionIndex(i);
430
  return m_functions[iFun]->activeParameter(i - m_paramOffsets[iFun]);
431
432
}

433
434
/// Set new value of i-th active parameter. Override this method to make
/// fitted parameters different from the declared
435
void CompositeFunction::setActiveParameter(size_t i, double value) {
436
  size_t iFun = functionIndex(i);
437
  m_functions[iFun]->setActiveParameter(i - m_paramOffsets[iFun], value);
438
439
440
}

/// Returns the name of active parameter i
441
std::string CompositeFunction::nameOfActive(size_t i) const {
442
  size_t iFun = functionIndex(i);
443
  std::ostringstream ostr;
444
445
  ostr << 'f' << iFun << '.'
       << m_functions[iFun]->nameOfActive(i - m_paramOffsets[iFun]);
446
447
448
449
  return ostr.str();
}

/// Returns the description of active parameter i
450
std::string CompositeFunction::descriptionOfActive(size_t i) const {
451
  size_t iFun = functionIndex(i);
452
  std::ostringstream ostr;
453
  ostr << m_functions[iFun]->descriptionOfActive(i - m_paramOffsets[iFun]);
454
  return ostr.str();
455
456
}

457
/// Change status of parameter
458
459
void CompositeFunction::setParameterStatus(size_t i,
                                           IFunction::ParameterStatus status) {
460
  size_t iFun = functionIndex(i);
461
  m_functions[iFun]->setParameterStatus(i - m_paramOffsets[iFun], status);
462
463
}

464
/// Get status of parameter
465
466
IFunction::ParameterStatus
CompositeFunction::getParameterStatus(size_t i) const {
467
  size_t iFun = functionIndex(i);
468
  return m_functions[iFun]->getParameterStatus(i - m_paramOffsets[iFun]);
469
470
}

471
/** Makes sure that the function is consistent.
472
 */
473
void CompositeFunction::checkFunction() {
474
  m_nParams = 0;
475
  m_nAttributes = nGlobalAttributes();
476
  m_paramOffsets.clear();
477
  m_IFunction.clear();
478
  m_attributeIndex.clear();
479

480
  std::vector<IFunction_sptr> functions(m_functions.begin(), m_functions.end());
481
482
  m_functions.clear();

Hahn, Steven's avatar
Hahn, Steven committed
483
  for (auto &f : functions) {
484
    CompositeFunction_sptr cf = std::dynamic_pointer_cast<CompositeFunction>(f);
485
486
    if (cf)
      cf->checkFunction();
487
488
489
490
    addFunction(f);
  }
}

491
/**
492
493
494
495
 * Remove all member functions
 */
void CompositeFunction::clear() {
  m_nParams = 0;
496
  m_nAttributes = nGlobalAttributes();
497
498
499
  m_paramOffsets.clear();
  m_IFunction.clear();
  m_functions.clear();
Stephen's avatar
Stephen committed
500
  m_attributeIndex.clear();
501
502
}

503
/** Add a function
504
 * @param f :: A pointer to the added function
505
 * @return The function index
506
 */
507
508
size_t CompositeFunction::addFunction(IFunction_sptr f) {
  m_IFunction.insert(m_IFunction.end(), f->nParams(), m_functions.size());
509
510
  m_attributeIndex.insert(m_attributeIndex.end(), f->nAttributes(),
                          m_functions.size());
511
  m_functions.emplace_back(f);
512
  if (m_paramOffsets.empty()) {
513
    m_paramOffsets.emplace_back(0);
514
    m_nParams = f->nParams();
515
    m_nAttributes = f->nAttributes() + nGlobalAttributes();
516
  } else {
517
    m_paramOffsets.emplace_back(m_nParams);
518
    m_nParams += f->nParams();
519
    m_nAttributes += f->nAttributes();
520
  }
521
  return m_functions.size() - 1;
522
523
}

524
/** Remove a function
525
 * @param i :: The index of the function to remove
526
 */
527
void CompositeFunction::removeFunction(size_t i) {
528
529
  if (i >= nFunctions()) {
    throw std::out_of_range("Function index (" + std::to_string(i) +
530
531
                            ") out of range (" + std::to_string(nFunctions()) +
                            ").");
532
  }
533

534
  IFunction_sptr fun = getFunction(i);
535
  // Remove ties which are no longer valid
536
537
538
  for (size_t j = 0; j < nParams();) {
    ParameterTie *tie = getTie(j);
    if (tie && tie->findParametersOf(fun.get())) {
539
      removeTie(j);
540
    } else {
541
542
543
544
      j++;
    }
  }

545
546
547
548
549
550
551
  // Shift down the function indices for parameters and attributes
  auto shiftDown = [&](auto &functionIndex) {
    if (functionIndex == i) {
      return true;
    } else if (functionIndex > i) {
      functionIndex -= 1;
      return false;
552
    } else {
553
      return false;
554
    }
555
  };
Stephen's avatar
Stephen committed
556

557
558
559
560
561
562
  m_IFunction.erase(
      std::remove_if(m_IFunction.begin(), m_IFunction.end(), shiftDown),
      m_IFunction.end());
  m_attributeIndex.erase(std::remove_if(m_attributeIndex.begin(),
                                        m_attributeIndex.end(), shiftDown),
                         m_attributeIndex.end());
563

Stephen's avatar
Stephen committed
564
565
566
567
  // Reduction in parameters and attributes
  m_nParams -= fun->nParams();
  m_nAttributes -= fun->nAttributes();

568
569
570
  // Shift the parameter offsets down by the total number of i-th function's
  // params
  for (size_t j = i + 1; j < nFunctions(); j++) {
571
    m_paramOffsets[j] -= fun->nParams();
572
  }
573
  m_paramOffsets.erase(m_paramOffsets.begin() + i);
574

575
  m_functions.erase(m_functions.begin() + i);
576
577
}

578
/** Replace a function with a new one. The old function is deleted.
579
 *  The new function must have already its workspace set.
580
 * @param f_old :: The pointer to the function to replace. If it's not
581
 *  a member of this composite function nothing happens
582
 * @param f_new :: A pointer to the new function
583
 */
David Fairbrother's avatar
David Fairbrother committed
584
585
void CompositeFunction::replaceFunctionPtr(const IFunction_sptr &f_old,
                                           const IFunction_sptr &f_new) {
586
587
588
589
  std::vector<IFunction_sptr>::const_iterator it =
      std::find(m_functions.begin(), m_functions.end(), f_old);
  if (it == m_functions.end())
    return;
590
  std::vector<IFunction_sptr>::difference_type iFun = it - m_functions.begin();
591
  replaceFunction(iFun, f_new);
592
593
}

594
/** Replace a function with a new one. The old function is deleted.
595
 * @param functionIndex :: The index of the function to replace
596
 * @param f :: A pointer to the new function
597
 */
598
599
600
601
void CompositeFunction::replaceFunction(size_t functionIndex,
                                        const IFunction_sptr &f) {
  if (functionIndex >= nFunctions()) {
    throw std::out_of_range("Function index (" + std::to_string(functionIndex) +
602
603
                            ") out of range (" + std::to_string(nFunctions()) +
                            ").");
604
  }
605

606
  IFunction_sptr fun = getFunction(functionIndex);
607
608
  size_t np_old = fun->nParams();
  size_t np_new = f->nParams();
Stephen's avatar
Stephen committed
609
610
  size_t at_old = fun->nAttributes();
  size_t at_new = f->nAttributes();
611

612
  // Modify function parameter and attribute indices:
613
  replaceVariableIndexRange(m_IFunction, np_old, np_new, functionIndex);
Stephen's avatar
Stephen committed
614
  replaceVariableIndexRange(m_attributeIndex, at_old, at_new, functionIndex);
615

616
  // Decrement attribute and parameter counts
617
  size_t dnp = np_new - np_old;
Stephen's avatar
Stephen committed
618
  size_t dna = at_new - at_old;
619
  m_nParams += dnp;
Stephen's avatar
Stephen committed
620
  m_nAttributes += dna;
621

622
623
  // Shift the parameter offsets down by the total number of i-th function's
  // params
624
  for (size_t j = functionIndex + 1; j < nFunctions(); j++) {
625
626
    m_paramOffsets[j] += dnp;
  }
627
  m_functions[functionIndex] = f;
628
629
}

630
/**
631
 * @param i :: The index of the function
632
 * @return function at the requested index
633
 */
634
635
IFunction_sptr CompositeFunction::getFunction(std::size_t i) const {
  if (i >= nFunctions()) {
636
    throw std::out_of_range("Function index (" + std::to_string(i) +
637
638
                            ") out of range (" + std::to_string(nFunctions()) +
                            ").");
639
  }
640
641
642
  return m_functions[i];
}

643
644
/**
 * Get the index of the function to which parameter i belongs
645
 * @param i :: The parameter index
646
 * @return function index of the requested parameter
647
 */
648
649
size_t CompositeFunction::functionIndex(std::size_t i) const {
  if (i >= nParams()) {
650
    throw std::out_of_range("Function parameter index (" + std::to_string(i) +
651
652
                            ") out of range (" + std::to_string(nParams()) +
                            ").");
653
  }
654
  return m_IFunction[i];
655
}
656
657
658
659
660
661
662
663
664
665
666
667
668
/**
 * Get the index of the function to which parameter i belongs
 * @param i :: The parameter index
 * @return function index of the requested parameter
 */
size_t CompositeFunction::attributeFunctionIndex(std::size_t i) const {
  if (i >= nAttributes()) {
    throw std::out_of_range("Function attribute index (" + std::to_string(i) +
                            ") out of range (" + std::to_string(nAttributes()) +
                            ").");
  }
  return m_attributeIndex[i];
}
669
670

/**
LamarMoore's avatar
LamarMoore committed
671
672
 * @param varName :: The variable name which may contain function index (
 * [f<index.>]name )
673
 * @return pair containing the unprefixed variable name and functionIndex
LamarMoore's avatar
LamarMoore committed
674
 */
675
676
std::pair<std::string, size_t>
CompositeFunction::parseName(const std::string &varName) {
677
  size_t i = varName.find('.');
678
  if (i == std::string::npos) {
679
    throw std::invalid_argument("Variable " + varName + " not found.");
680
  } else {
681
    if (varName[0] != 'f')
682
      throw std::invalid_argument(
683
          "External function variable name must start with 'f'");
684

685
    std::string sindex = varName.substr(1, i - 1);
686
    size_t index = boost::lexical_cast<size_t>(sindex);
687
688
689
690

    if (i == varName.size() - 1)
      throw std::invalid_argument("Name cannot be empty");

691
    return std::make_pair(varName.substr(i + 1), index);
692
  }
693
694
}

695
/** Returns the index of parameter i as it declared in its function
696
 * @param i :: The parameter index
697
 * @param recursive :: If true call parameterLocalName recursively until
698
 *    a non-composite function is reached.
699
700
 * @return The local index of the parameter
 */
701
size_t CompositeFunction::parameterLocalIndex(size_t i, bool recursive) const {
702
  size_t iFun = functionIndex(i);
703
704
  auto localIndex = i - m_paramOffsets[iFun];
  if (recursive) {
705
    auto cf = dynamic_cast<const CompositeFunction *>(m_functions[iFun].get());
706
707
708
709
710
    if (cf) {
      return cf->parameterLocalIndex(localIndex, recursive);
    }
  }
  return localIndex;
711
712
}

713
/** Returns the name of parameter i as it declared in its function
714
 * @param i :: The parameter index
715
 * @param recursive :: If true call parameterLocalName recursively until
716
 *    a non-composite function is reached.
717
718
 * @return The pure parameter name (without the function identifier f#.)
 */
719
720
std::string CompositeFunction::parameterLocalName(size_t i,
                                                  bool recursive) const {
721
  size_t iFun = functionIndex(i);
722
723
724
  auto localIndex = i - m_paramOffsets[iFun];
  auto localFunction = m_functions[iFun].get();
  if (recursive) {
725
    auto cf = dynamic_cast<const CompositeFunction *>(localFunction);
726
727
728
729
730
    if (cf) {
      return cf->parameterLocalName(localIndex, recursive);
    }
  }
  return localFunction->parameterName(localIndex);
731
732
}

733
/**
734
 * Apply the ties.
735
 */
736
void CompositeFunction::applyTies() {
737
738
739
740
741
742
743
  if (hasOrderedTies()) {
    applyOrderedTies();
  } else {
    for (size_t i = 0; i < nFunctions(); i++) {
      getFunction(i)->applyTies();
    }
    IFunction::applyTies();
744
745
746
747
  }
}

/**
748
 * Clear the ties.
749
 */
750
void CompositeFunction::clearTies() {
751
  IFunction::clearTies();
752
  for (size_t i = 0; i < nFunctions(); i++) {
753
754
755
756
757
    getFunction(i)->clearTies();
  }
}

/** Removes i-th parameter's tie if it is tied or does nothing.
758
 * @param i :: The index of the tied parameter.
759
 * @return True if successful
760
 */
761
bool CompositeFunction::removeTie(size_t i) {
762
763
764
765
766
767
768
  bool foundAndRemovedTie = IFunction::removeTie(i);
  if (!foundAndRemovedTie) {
    size_t iFun = functionIndex(i);
    bool res = m_functions[iFun]->removeTie(i - m_paramOffsets[iFun]);
    return res;
  }
  return foundAndRemovedTie;
769
770
771
}

/** Get the tie of i-th parameter
772
 * @param i :: The parameter index
773
 * @return A pointer to the tie.
774
 */
775
ParameterTie *CompositeFunction::getTie(size_t i) const {
776
777
778
779
780
781
  auto tie = IFunction::getTie(i);
  if (tie == nullptr) {
    size_t iFun = functionIndex(i);
    tie = m_functions[iFun]->getTie(i - m_paramOffsets[iFun]);
  }
  return tie;
782
783
784
}

/**
785
 * Declare a new parameter. To used in the implementation's constructor.
786
787
 * @param name :: The parameter name.
 * @param initValue :: The initial value for the parameter
788
 * @param description :: Parameter documentation
789
 */
790
791
792
793
794
795
796
797
void CompositeFunction::declareParameter(const std::string &name,
                                         double initValue,
                                         const std::string &description) {
  (void)name;        // Avoid compiler warning
  (void)initValue;   // Avoid compiler warning
  (void)description; // Avoid compiler warning
  throw Kernel::Exception::NotImplementedError(
      "CompositeFunction cannot not have its own parameters.");
798
}
799
800
801
802
803
804
805
806
807
808
/**
 * Declares a single (global) attribute on the composite function
 * @param name :: The name of the attribute
 * @param defaultValue :: A default value
 */
void CompositeFunction::declareAttribute(
    const std::string &name, const API::IFunction::Attribute &defaultValue) {
  m_globalAttributeNames.emplace_back(name);
  IFunction::declareAttribute(name, defaultValue);
}
809

810
811
812
/**
 * Prepare the function for a fit.
 */
813
void CompositeFunction::setUpForFit() {
814
  IFunction::setUpForFit();
815
  // set up the member functions
816
  for (size_t i = 0; i < nFunctions(); i++) {
817
    getFunction(i)->setUpForFit();
818
  }
819
820

  // Instead of automatically switching to numeric derivatives
821
  // log a warning about a danger of not using it
822
823
824
825
826
  if (!getAttribute("NumDeriv").asBool()) {
    for (size_t i = 0; i < nParams(); ++i) {
      ParameterTie *tie = getTie(i);
      if (tie && !tie->isConstant()) {
        g_log.warning() << "Numeric derivatives should be used when "
827
                           "non-constant ties defined.\n";
828
829
        break;
      }
830
    }