CompositeFunction.cpp 25 KB
Newer Older
1
2
3
4
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/Exception.h"
5
6
#include "MantidAPI/CompositeFunction.h"
#include "MantidAPI/ParameterTie.h"
7
#include "MantidAPI/IConstraint.h"
8

9
#include <boost/lexical_cast.hpp>
10
11
12
#include <boost/shared_array.hpp>
#include <sstream>
#include <iostream>
13
#include <algorithm>
14
15
16
17
18
19

namespace Mantid
{
namespace API
{

20
//DECLARE_FUNCTION(CompositeFunction)
21

22
23
/// Copy contructor
CompositeFunction::CompositeFunction(const CompositeFunction& f)
24
:m_nActive(f.m_nParams),m_nParams(f.m_nParams),m_iConstraintFunction(0)
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  m_functions.assign(f.m_functions.begin(),f.m_functions.end());
  m_activeOffsets.assign(f.m_activeOffsets.begin(),f.m_activeOffsets.end());
  m_paramOffsets.assign(f.m_paramOffsets.begin(),f.m_paramOffsets.end());
}

///Assignment operator
CompositeFunction& CompositeFunction::operator=(const CompositeFunction& f)
{
  m_nActive = f.m_nActive;
  m_nParams = f.m_nParams;
  m_functions.assign(f.m_functions.begin(),f.m_functions.end());
  m_activeOffsets.assign(f.m_activeOffsets.begin(),f.m_activeOffsets.end());
  m_paramOffsets.assign(f.m_paramOffsets.begin(),f.m_paramOffsets.end());
39
  m_iConstraintFunction = f.m_iConstraintFunction;
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
  return *this;
}

///Destructor
CompositeFunction::~CompositeFunction()
{
  for(int i=0;i<nFunctions();i++)
    if (m_functions[i]) delete m_functions[i];
}


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

56
57
58
59
60
61
62
63
64
65
66
/** 
 * Writes itself into a string. Functions derived from CompositeFunction must
 * override this method with something like this:
 *   std::string NewFunction::asString()const
 *   {
 *      ostr << "composite=" << this->name() << ';';
 *      // write NewFunction's own attributes and parameters
 *      ostr << CompositeFunction::asString();
 *      // write NewFunction's own ties and constraints
 *      // ostr << ";constraints=(" << ... <<")";
 *   }
67
 * @return the string representation of the composite function
68
 */
69
70
71
72
73
std::string CompositeFunction::asString()const
{
  std::ostringstream ostr;
  for(int i=0;i<nFunctions();i++)
  {
74
    IFitFunction* fun = getFunction(i);
75
76
    bool isComp = dynamic_cast<CompositeFunction*>(fun) != 0;
    if (isComp) ostr << '(';
77
    ostr << fun->asString();
78
    if (isComp) ostr << ')';
79
80
81
82
83
84
85
86
87
88
89
    if (i < nFunctions() - 1)
    {
      ostr << ';';
    }
  }
  std::string ties;
  for(int i=0;i<nParams();i++)
  {
    const ParameterTie* tie = getTie(i);
    if (tie)
    {
90
      IFitFunction* fun = getFunction(functionIndex(i));
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
      std::string tmp = tie->asString(fun);
      if (tmp.empty())
      {
        tmp = tie->asString(this);
        if (!tmp.empty())
        {
          if (!ties.empty())
          {
            ties += ",";
          }
          ties += tmp;
        }
      }
    }
  }
  if (!ties.empty())
  {
    ostr << ";ties=(" << ties << ")";
109
110
111
112
  }
  return ostr.str();
}

113
/// Function you want to fit to.
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
//void CompositeFunction::function(double* out, const double* xValues, const int& nData)const
//{
//  if (nData <= 0) return;
//  boost::shared_array<double> tmpOut(new double[nData]);
//  for(int i=0;i<nFunctions();i++)
//  {
//    if (i == 0)
//      m_functions[i]->function(out,xValues,nData);
//    else
//    {
//      m_functions[i]->function(tmpOut.get(),xValues,nData);
//      std::transform(out,out+nData,tmpOut.get(),out,std::plus<double>());
//    }
//  }
//}
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

/** A Jacobian for individual functions
 */
class PartialJacobian: public Jacobian
{
  Jacobian* m_J;  ///< pointer to the overall Jacobian
  int m_iP0;      ///< offset in the overall Jacobian for a particular function
  int m_iaP0;      ///< offset in the active Jacobian for a particular function
public:
  /** Constructor
   * @param J A pointer to the overall Jacobian
   * @param iP0 The parameter index (declared) offset for a particular function
   * @param iap0 The active parameter index (declared) offset for a particular function
   */
  PartialJacobian(Jacobian* J,int iP0, int iap0):m_J(J),m_iP0(iP0),m_iaP0(iap0)
  {}
  /**
   * Overridden Jacobian::set(...).
   * @param iY The index of the data point
   * @param iP The parameter index of an individual function.
   * @param value The derivative value
   */
  void set(int iY, int iP, double value)
  {
      m_J->set(iY,m_iP0 + iP,value);
  }
 /**  Add number to all iY (data) Jacobian elements for a given iP (parameter)
  *   @param value Value to add
  *   @param iActiveP The index of an active parameter.
  */
  virtual void addNumberToColumn(const double& value, const int& iActiveP) 
  {
    m_J->addNumberToColumn(value,m_iaP0+iActiveP);
  }
};

/// Derivatives of function with respect to active parameters
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
//void CompositeFunction::functionDeriv(Jacobian* out, const double* xValues, const int& nData)
//{
//  for(int i=0;i<nFunctions();i++)
//  {
//    PartialJacobian J(out,m_paramOffsets[i],m_activeOffsets[i]);
//    m_functions[i]->functionDeriv(&J,xValues,nData);
//  }
//}
//
///// Derivatives to be used in covariance matrix calculation. 
//void CompositeFunction::calJacobianForCovariance(Jacobian* out, const double* xValues, const int& nData)
//{
//  if (nData <= 0) return;
//  for(int i=0;i<nFunctions();i++)
//  {
//    PartialJacobian J(out,m_paramOffsets[i],m_activeOffsets[i]);
//    m_functions[i]->calJacobianForCovariance(&J,xValues,nData);
//  }
//}
185
186


187
188
189
190
191
192
/** Sets a new value to the i-th parameter.
 *  @param i The parameter index
 *  @param value The new value
 *  @param explicitlySet A boolean falgging the parameter as explicitly set (by user)
 */
void CompositeFunction::setParameter(int i, const double& value, bool explicitlySet)
193
{
194
  int iFun = functionIndex(i);
195
  m_functions[ iFun ]->setParameter(i - m_paramOffsets[iFun],value,explicitlySet);
196
197
}

198
199
/** Get the i-th parameter.
 *  @param i The parameter index
200
 *  @return value of the requested parameter
201
202
 */
double CompositeFunction::getParameter(int i)const
203
{
204
  int iFun = functionIndex(i);
205
  return m_functions[ iFun ]->getParameter(i - m_paramOffsets[iFun]);
206
207
}

208
209
210
211
212
213
214
/**
 * Sets a new value to a parameter by name.
 * @param name The name of the parameter.
 * @param value The new value
 * @param explicitlySet A boolean falgging the parameter as explicitly set (by user)
 */
void CompositeFunction::setParameter(const std::string& name, const double& value, bool explicitlySet)
215
{
216
217
218
219
220
221
222
223
224
  std::string pname;
  int index;
  parseName(name,index,pname);
  if (index < 0)
    throw std::invalid_argument("CompositeFunction::getParameter: parameter name must contain function index");
  else
  {   
    getFunction(index)->setParameter(pname,value,explicitlySet);
  }
225
226
}

227
228
229
/**
 * Parameters by name.
 * @param name The name of the parameter.
230
 * @return value of the requested named parameter
231
 */
232
233
double CompositeFunction::getParameter(const std::string& name)const
{
234
235
236
237
238
239
240
241
242
  std::string pname;
  int index;
  parseName(name,index,pname);
  if (index < 0)
    throw std::invalid_argument("CompositeFunction::getParameter: parameter name must contain function index");
  else
  {   
    return getFunction(index)->getParameter(pname);
  }
243
244
245
246
247
248
249
250
}

/// Total number of parameters
int CompositeFunction::nParams()const
{
  return m_nParams;
}

251
/**
252
 * 
253
 * @param name The name of a parameter
254
 * @return index of the requested named parameter
255
256
257
 */
int CompositeFunction::parameterIndex(const std::string& name)const
{
258
259
260
261
262
263
  std::string pname;
  int index;
  parseName(name,index,pname);
  if (index < 0)
    throw std::invalid_argument("CompositeFunction::getParameter: parameter name must contain function index");

264
  return getFunction(index)->parameterIndex(pname) + m_paramOffsets[index];
265
266
}

Nick Draper's avatar
re #100    
Nick Draper committed
267
268
269
/// Returns the name of parameter
/// @param i The index
/// @return The name of the parameter
270
271
std::string CompositeFunction::parameterName(int i)const
{
272
  int iFun = functionIndex(i);
273
274
275
  std::ostringstream ostr;
  ostr << 'f' << iFun << '.' << m_functions[ iFun ]->parameterName(i - m_paramOffsets[iFun]);
  return ostr.str();
276
277
278
279
280
281
282
283
284
285
286
}

/// Number of active (in terms of fitting) parameters
int CompositeFunction::nActive()const
{
  return m_nActive;
}

/// Value of i-th active parameter. Override this method to make fitted parameters different from the declared
double CompositeFunction::activeParameter(int i)const
{
287
  int iFun = functionIndexActive(i);
288
289
290
291
292
293
  return m_functions[ iFun ]->activeParameter(i - m_activeOffsets[iFun]);
}

/// Set new value of i-th active parameter. Override this method to make fitted parameters different from the declared
void CompositeFunction::setActiveParameter(int i, double value)
{
294
  int iFun = functionIndexActive(i);
295
  m_functions[ iFun ]->setActiveParameter(i - m_activeOffsets[iFun],value);
296
297
298
299
300
301
302
303
304
}

/// Update parameters after a fitting iteration
void CompositeFunction::updateActive(const double* in)
{
  for(int iFun = 0; iFun < int(m_functions.size()); iFun++)
  {
    m_functions[ iFun ]->updateActive(in + m_activeOffsets[ iFun ]);
  }
305
  applyTies();
306
307
308
309
310
}

/// Returns "global" index of active parameter i
int CompositeFunction::indexOfActive(int i)const
{
311
  int iFun = functionIndexActive(i);
312
313
314
315
316
317
  return m_paramOffsets[ iFun ] + m_functions[ iFun ]->indexOfActive(i - m_activeOffsets[iFun]);
}

/// Returns the name of active parameter i
std::string CompositeFunction::nameOfActive(int i)const
{
318
  int iFun = functionIndexActive(i);
319
320
321
  std::ostringstream ostr;
  ostr << 'f' << iFun << '.' << m_functions[ iFun ]->nameOfActive(i - m_activeOffsets[iFun]);
  return ostr.str();
322
323
}

324
/**
325
 * query to see in the function is active
326
 * @param i The index of a declared parameter
327
 * @return true if parameter i is active
328
329
330
331
332
333
334
335
336
337
338
339
 */
bool CompositeFunction::isActive(int i)const
{
  int iFun = functionIndex(i);
  return m_functions[ iFun ]->isActive(i - m_paramOffsets[iFun]);
}

/**
 * @param i A declared parameter index to be removed from active
 */
void CompositeFunction::removeActive(int i)
{
340
  if (!isActive(i)) return;
341
342
  int iFun = functionIndex(i);
  int ia = m_activeOffsets[iFun] + m_functions[iFun]->activeIndex(i - m_paramOffsets[iFun]);
343
  m_IFitFunctionActive.erase(m_IFitFunctionActive.begin()+ia);
344
345
  m_functions[ iFun ]->removeActive(i - m_paramOffsets[iFun]);

346
  m_nActive--;
347
348
349
350
  for(int j=iFun+1;j<nFunctions();j++)
    m_activeOffsets[j] -= 1;
}

351
352
353
354
355
356
357
358
359
/** Makes a parameter active again. It doesn't change the parameter's tie.
 * @param i A declared parameter index to be restored to active
 */
void CompositeFunction::restoreActive(int i)
{
  int iFun = functionIndex(i);
  int ia = m_activeOffsets[iFun] + m_functions[iFun]->activeIndex(i - m_paramOffsets[iFun]);

  std::vector<int>::iterator itFun = 
360
    std::find_if(m_IFitFunctionActive.begin(),m_IFitFunctionActive.end(),std::bind2nd(std::greater<int>(),i));
361

362
  m_IFitFunctionActive.insert(itFun,1,ia);
363
364
365
366
367
368
369
  m_functions[ iFun ]->restoreActive(i - m_paramOffsets[iFun]);

  m_nActive++;
  for(int j=iFun+1;j<nFunctions();j++)
    m_activeOffsets[j] += 1;
}

370
371
372
373
374
375
376
377
/**
 * @param i The index of a declared parameter
 * @return The index of declared parameter i in the list of active parameters or -1
 *         if the parameter is tied.
 */
int CompositeFunction::activeIndex(int i)const
{
  int iFun = functionIndex(i);
378
379
380
381
382
383
384
385
  int j = m_functions[iFun]->activeIndex(i - m_paramOffsets[iFun]);

  if (j == -1) 
  {
    return -1;
  }

  return m_activeOffsets[iFun] + j;
386
387
}

388
389
390
391
392
393
394
395
/** Makes sure that the function is consistent. 
 */
void CompositeFunction::checkFunction()
{
  m_nParams = 0;
  m_nActive = 0;
  m_paramOffsets.clear();
  m_activeOffsets.clear();
396
397
  m_IFitFunction.clear();
  m_IFitFunctionActive.clear();
398

399
  std::vector<IFitFunction*> functions(m_functions.begin(),m_functions.end());
400
401
  m_functions.clear();

402
  for(std::vector<IFitFunction*>::size_type i=0;i<functions.size();i++)
403
  {
404
    IFitFunction* f = functions[i];
405
406
    CompositeFunction* cf = dynamic_cast<CompositeFunction*>(f);
    if (cf) cf->checkFunction();
407
408
409
410
    addFunction(f);
  }
}

411
412
/** Add a function
 * @param f A pointer to the added function
413
 * @return The function index
414
 */
415
int CompositeFunction::addFunction(IFitFunction* f)
416
{
417
418
  m_IFitFunction.insert(m_IFitFunction.end(),f->nParams(),m_functions.size());
  m_IFitFunctionActive.insert(m_IFitFunctionActive.end(),f->nActive(),m_functions.size());
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
  m_functions.push_back(f);
  //?f->init();
  if (m_paramOffsets.size() == 0)
  {
    m_paramOffsets.push_back(0);
    m_activeOffsets.push_back(0);
    m_nParams = f->nParams();
    m_nActive = f->nActive();
  }
  else
  {
    m_paramOffsets.push_back(m_nParams);
    m_activeOffsets.push_back(m_nActive);
    m_nParams += f->nParams();
    m_nActive += f->nActive();
  }
435
  return m_functions.size()-1;
436
437
}

438
439
/** Remove a function
 * @param i The index of the function to remove
440
 * @param del The deletion flag. If true the function will be deleted otherwise - simply detached
441
 */
442
void CompositeFunction::removeFunction(int i, bool del)
443
444
445
446
{
  if ( i >= nFunctions() )
    throw std::out_of_range("Function index out of range.");

447
  IFitFunction* fun = getFunction(i);
448
449
450
451
452
453
454

  int dna = fun->nActive();
  int dnp = fun->nParams();

  for(int j=0;j<nParams();)
  {
    ParameterTie* tie = getTie(j);
455
    if (tie && tie->findParametersOf(fun))
456
457
458
459
460
461
462
463
464
465
    {
      removeTie(j);
    }
    else
    {
      j++;
    }
  }

  // Shift down the function indeces for parameters
466
  for(std::vector<int>::iterator it=m_IFitFunction.begin();it!=m_IFitFunction.end();)
467
  {
468

469
470
    if (*it == i)
    {
471
      it = m_IFitFunction.erase(it);
472
    }
473
    else
474
    {
475
476
477
478
479
      if (*it > i)
      {
        *it -= 1;
      }
      it++;
480
481
482
483
    }
  }

  // Shift down the function indeces for active parameters
484
  for(std::vector<int>::iterator it=m_IFitFunctionActive.begin();it!=m_IFitFunctionActive.end();)
485
486
487
  {
    if (*it == i)
    {
488
      it = m_IFitFunctionActive.erase(it);
489
    }
490
    else
491
    {
492
493
494
495
496
      if (*it > i)
      {
        *it -= 1;
      }
      it++;
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    }
  }

  m_nActive -= dna;
  // Shift the active offsets down by the number of i-th function's active params
  for(int j=i+1;j<nFunctions();j++)
  {
    m_activeOffsets[j] -= dna;
  }
  m_activeOffsets.erase(m_activeOffsets.begin()+i);

  m_nParams -= dnp;
  // Shift the parameter offsets down by the total number of i-th function's params
  for(int j=i+1;j<nFunctions();j++)
  {
    m_paramOffsets[j] -= dnp;
  }
  m_paramOffsets.erase(m_paramOffsets.begin()+i);

  m_functions.erase(m_functions.begin()+i);
517
518
519
520
  if (del)
  {
    delete fun;
  }
521
522
}

523
/** Replace a function with a new one. The old function is deleted.
524
 *  The new function must have already its workspace set.
525
526
527
528
 * @param f_old The pointer to the function to replace. If it's not
 *  a member of this composite function nothing happens
 * @param f_new A pointer to the new function
 */
529
void CompositeFunction::replaceFunction(const IFitFunction* f_old,IFitFunction* f_new)
530
{
531
  std::vector<IFitFunction*>::const_iterator it = 
532
533
    std::find(m_functions.begin(),m_functions.end(),f_old);
  if (it == m_functions.end()) return;
534
//  f_new->setMatrixWorkspace(f_old->getMatrixWorkspace(),f_old->getWorkspaceIndex(),-1,-1);
535
536
537
538
  int iFun = it - m_functions.begin();
  replaceFunction(iFun,f_new);
}

539
540
541
542
/** Replace a function with a new one. The old function is deleted.
 * @param i The index of the function to replace
 * @param f A pointer to the new function
 */
543
void CompositeFunction::replaceFunction(int i,IFitFunction* f)
544
545
546
547
{
  if ( i >= nFunctions() )
    throw std::out_of_range("Function index out of range.");

548
  IFitFunction* fun = getFunction(i);
549
550
551
552
553
554
555
556
  int na_old = fun->nActive();
  int np_old = fun->nParams();

  int na_new = f->nActive();
  int np_new = f->nParams();

  // Modify function indeces: The new function may have different number of parameters
  {
557
558
    std::vector<int>::iterator itFun = std::find(m_IFitFunction.begin(),m_IFitFunction.end(),i);
    if(itFun != m_IFitFunction.end()) // functions must have at least 1 parameter
559
    {
560
561
      if (np_old > np_new)
      {
562
        m_IFitFunction.erase(itFun,itFun + np_old - np_new);
563
564
565
      }
      else if (np_old < np_new) 
      {
566
        m_IFitFunction.insert(itFun,np_new - np_old,i);
567
      }
568
    }
569
570
    else if (np_new > 0) // it could happen if the old function is an empty CompositeFunction
    {
571
572
      itFun = std::find_if(m_IFitFunction.begin(),m_IFitFunction.end(),std::bind2nd(std::greater<int>(),i));
      m_IFitFunction.insert(itFun,np_new,i);
573
    }
574
575
576
577
  }

  // Modify function indeces: The new function may have different number of active parameters
  {
578
579
    std::vector<int>::iterator itFun = std::find(m_IFitFunctionActive.begin(),m_IFitFunctionActive.end(),i);
    if (itFun != m_IFitFunctionActive.end())
580
581
582
    {
      if (na_old > na_new)
      {
583
        m_IFitFunctionActive.erase(itFun,itFun + na_old - na_new);
584
585
586
      }
      else if (na_old < na_new) 
      {
587
        m_IFitFunctionActive.insert(itFun,na_new - na_old,i);
588
589
590
591
      }
    }
    else if (na_new > 0)
    {
592
593
      itFun = std::find_if(m_IFitFunctionActive.begin(),m_IFitFunctionActive.end(),std::bind2nd(std::greater<int>(),i));
      m_IFitFunctionActive.insert(itFun,na_new,i);
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
    }
  }

  int dna = na_new - na_old;
  m_nActive += dna;
  // Recalc the active offsets 
  for(int j=i+1;j<nFunctions();j++)
  {
    m_activeOffsets[j] += dna;
  }

  int dnp = np_new - np_old;
  m_nParams += dnp;
  // Shift the parameter offsets down by the total number of i-th function's params
  for(int j=i+1;j<nFunctions();j++)
  {
    m_paramOffsets[j] += dnp;
  }

  m_functions[i] = f;
  delete fun;
}

617
618
/**
 * @param i The index of the function
619
 * @return function at the requested index
620
 */
621
IFitFunction* CompositeFunction::getFunction(int i)const
622
{
623
624
  if ( i >= nFunctions()  || i < 0)
  {
625
    throw std::out_of_range("Function index out of range.");
626
  }
627
628
629
  return m_functions[i];
}

630
631
632
/**
 * Get the index of the function to which parameter i belongs
 * @param i The parameter index
633
 * @return function index of the requested parameter
634
635
636
 */
int CompositeFunction::functionIndex(int i)const
{
637
638
  if (i >= nParams() || i < 0)
  {
639
    throw std::out_of_range("Function parameter index out of range.");
640
  }
641
  return m_IFitFunction[i];
642
643
644
645
646
}

/**
 * Get the index of the function to which parameter i belongs
 * @param i The active parameter index
647
 * @return active function index of the requested parameter
648
649
650
 */
int CompositeFunction::functionIndexActive(int i)const
{
651
  if (i >= nParams() || i < 0)
652
    throw std::out_of_range("Function parameter index out of range.");
653
  return m_IFitFunctionActive[i];
654
655
656
657
658
659
660
661
662
}

/**
* @param varName The variable name which may contain function index ( [f<index.>]name )
* @param index Receives function index or -1 
* @param name Receives the parameter name
*/
void CompositeFunction::parseName(const std::string& varName,int& index, std::string& name)
{
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
  size_t i = varName.find('.');
  if (i == std::string::npos)
  {
    name = varName;
    index = -1;
    return;
  }
  else
  {
    if (varName[0] != 'f')
      throw std::invalid_argument("External function parameter name must start with 'f'");

    std::string sindex = varName.substr(1,i-1);
    index = boost::lexical_cast<int>(sindex);

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

    name = varName.substr(i+1);
  }
683
684
}

685
686
687
688
689
690
691
692
693
694
/** Returns the index of parameter i as it declared in its function
 * @param i The parameter index
 * @return The local index of the parameter
 */
int CompositeFunction::parameterLocalIndex(int i)const
{
  int iFun = functionIndex(i);
  return i - m_paramOffsets[iFun];
}

695
696
697
698
699
700
701
702
703
704
/** Returns the name of parameter i as it declared in its function
 * @param i The parameter index
 * @return The pure parameter name (without the function identifier f#.)
 */
std::string CompositeFunction::parameterLocalName(int i)const
{
  int iFun = functionIndex(i);
  return m_functions[ iFun ]->parameterName(i - m_paramOffsets[iFun]);
}

705
706
707
708
709
710
/** Initialize the function providing it the workspace
 * @param workspace The shared pointer to a workspace to which the function will be fitted
 * @param spec The number of a spectrum for fitting
 * @param xMin The minimum bin index of spectrum spec that will be used in fitting
 * @param xMax The maximum bin index of spectrum spec that will be used in fitting
 */
711
712
713
714
715
716
717
718
//void CompositeFunction::setMatrixWorkspace(boost::shared_ptr<const API::MatrixWorkspace> workspace,int spec,int xMin,int xMax)
//{
//  IFitFunction::setMatrixWorkspace(workspace,spec,xMin,xMax);
//  for(int i=0;i<nFunctions();i++)
//  {
//    getFunction(i)->setMatrixWorkspace(workspace,spec,xMin,xMax);
//  }
//}
719

720
/**
721
 * Apply the ties.
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 */
void CompositeFunction::applyTies()
{
  for(int i=0;i<nFunctions();i++)
  {
    getFunction(i)->applyTies();
  }
}

/**
 * Clear the ties. 
 */
void CompositeFunction::clearTies()
{
  for(int i=0;i<nFunctions();i++)
  {
    getFunction(i)->clearTies();
  }
}

/** Removes i-th parameter's tie if it is tied or does nothing.
 * @param i The index of the tied parameter.
 * @return True if successfull
 */
bool CompositeFunction::removeTie(int i)
{
  int iFun = functionIndex(i);
  bool res = m_functions[ iFun ]->removeTie(i - m_paramOffsets[iFun]);
  if (res)
  {
    m_nActive++;
  }
  return res;
}

/** Get the tie of i-th parameter
758
759
 * @param i The parameter index
 * @return A pointer to the tie.
760
761
762
763
764
765
766
767
768
769
770
771
772
 */
ParameterTie* CompositeFunction::getTie(int i)const
{
  int iFun = functionIndex(i);
  return m_functions[ iFun ]->getTie(i - m_paramOffsets[iFun]);
}

/**
 * Attaches a tie to this function. The attached tie is owned by the function.
 * @param tie A pointer to a new tie
 */
void CompositeFunction::addTie(ParameterTie* tie)
{
773
  int i = getParameterIndex(*tie);
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
  if (i < 0)
  {
    throw std::logic_error("Trying to use a tie on a parameter not belonging to this function");
  }
  int iFun = functionIndex(i);
  m_functions[iFun]->addTie(tie);
}

/**
 * Declare a new parameter. To used in the implementation'c constructor.
 * @param name The parameter name.
 * @param initValue The initial value for the parameter
 */
void CompositeFunction::declareParameter(const std::string& name,double initValue )
{
789
790
  (void) name; //Avoid compiler warning
  (void) initValue; //Avoid compiler warning
791
792
793
794
795
796
797
798
  throw Kernel::Exception::NotImplementedError("CompositeFunction cannot not have its own parameters.");
}

/** Add a constraint
 *  @param ic Pointer to a constraint.
 */
void CompositeFunction::addConstraint(IConstraint* ic)
{
799
800
801
  int i = getParameterIndex(*ic);
  int iFun = functionIndex(i);
  getFunction(iFun)->addConstraint(ic);
802
803
}

804
805
806
807
808
809
810
811
void CompositeFunction::setParametersToSatisfyConstraints()
{
  for(int i=0;i<nFunctions();i++)
  {
    getFunction(i)->setParametersToSatisfyConstraints();
  }
}

Nick Draper's avatar
re #100    
Nick Draper committed
812
813
814
/// Get constraint
/// @param i the index
/// @return A pointer to the constraint
815
IConstraint* CompositeFunction::getConstraint(int i)const
816
{
817
818
  int iFun = functionIndex(i);
  return m_functions[ iFun ]->getConstraint(i - m_paramOffsets[iFun]);
819
820
}

821
822
823
824
825
826
827
828
829
830
/** Remove a constraint
 * @param parName The name of a parameter which constarint to remove.
 */
void CompositeFunction::removeConstraint(const std::string& parName)
{
  int iPar = parameterIndex(parName);
  int iFun = functionIndex(iPar);
  getFunction(iFun)->removeConstraint(parameterLocalName(iPar));
}

831
/** Checks if a constraint has been explicitly set
832
 *  @param i The parameter index
833
 *  @return true if the function is explicitly set
834
835
836
837
838
839
840
 */
bool CompositeFunction::isExplicitlySet(int i)const
{
  int iFun = functionIndex(i);
  return m_functions[ iFun ]->isExplicitlySet(i - m_paramOffsets[iFun]);
}

841
842
843
844
845
846
847
/**
 * Returns the index of parameter if the ref points to one of the member function or -1
 * @param ref A reference to a parameter
 * @return Parameter index or -1
 */
int CompositeFunction::getParameterIndex(const ParameterReference& ref)const
{
848
  if (ref.getFunction() == this && ref.getIndex() < nParams())
849
850
851
  {
    return ref.getIndex();
  }
852
853
854
855
856
857
858
859
  for(int iFun=0;iFun<nFunctions();iFun++)
  {
    int iLocalIndex = getFunction(iFun)->getParameterIndex(ref);
    if (iLocalIndex >= 0)
    {
      return m_paramOffsets[iFun] + iLocalIndex;
    }
  }
860
861
862
  return -1;
}

863
864
865
866
/**
 * @param ref The reference
 * @return A function containing parameter pointed to by ref
 */
867
IFitFunction* CompositeFunction::getContainingFunction(const ParameterReference& ref)const
868
869
870
871
872
873
874
{
  if (ref.getFunction() == this && ref.getIndex() < nParams())
  {
    return ref.getFunction();
  }
  for(int iFun=0;iFun<nFunctions();iFun++)
  {
875
    IFitFunction* fun = static_cast<IFitFunction*>(getFunction(iFun)->getContainingFunction(ref));
876
877
878
879
880
881
882
    if (fun)
    {
      return getFunction(iFun);
    }
  }
  return NULL;
}
883

884
885
886
887
/**
 * @param fun The searched function
 * @return A function containing the argument function fun
 */
888
IFitFunction* CompositeFunction::getContainingFunction(const IFitFunction* fun)
889
890
891
892
893
894
895
{
  if (fun == this)
  {
    return this;
  }
  for(int iFun=0;iFun<nFunctions();iFun++)
  {
896
    IFitFunction* f = static_cast<IFitFunction*>(getFunction(iFun)->getContainingFunction(fun));
897
898
899
900
901
902
903
904
    if (f)
    {
      return getFunction(iFun);
    }
  }
  return NULL;
}

905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
//void CompositeFunction::setWorkspace(boost::shared_ptr<Workspace> ws,const std::string& slicing)
//{
//  IFitFunction::setWorkspace(ws,slicing);
//  for(int iFun=0;iFun<nFunctions();iFun++)
//  {
//    getFunction(iFun)->setUpNewStuff(m_xValues,m_weights);
//  }
//}

//void CompositeFunction::setUpNewStuff(boost::shared_array<double> xs,boost::shared_array<double> weights)
//{
//  IFitFunction::setUpNewStuff(xs,weights);
//  for(int iFun=0;iFun<nFunctions();iFun++)
//  {
//    getFunction(iFun)->setUpNewStuff(xs,weights);
//  }
//}
922

923
924
} // namespace API
} // namespace Mantid