nub.ts 47.2 KB
Newer Older
1
import { CalculatorType, ComputeNode } from "./compute-node";
2
import { Dichotomie } from "./dichotomie";
3
import { acSection, IParamDefinitionIterator, MacrorugoCompound, Pab, ParamDefinition, ParamsEquation,
4
         ParamsEquationArrayIterator, Session, Structure } from "./index";
5
import { LinkedValue } from "./linked-value";
6
import { ParamCalculability, ParamFamily } from "./param/param-definition";
7
import { ParamValueMode } from "./param/param-value-mode";
Mathias Chouet's avatar
Mathias Chouet committed
8
import { ParamValues } from "./param/param-values";
Mathias Chouet's avatar
Mathias Chouet committed
9
import { Props } from "./props";
10
import { IObservable, Observable, Observer } from "./util/observer";
11
import { Result } from "./util/result";
12
import { ResultElement } from "./util/resultelement";
13

14
/**
Mathias Chouet's avatar
Mathias Chouet committed
15
16
 * Classe abstraite de Noeud de calcul dans une session :
 * classe de base pour tous les calculs
17
 */
18
export abstract class Nub extends ComputeNode implements IObservable {
19

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
    protected static concatPrms(p1: ParamsEquation[], p2: ParamsEquation[]): ParamsEquation[] {
        const p3: ParamsEquation[] = p1;
        for (const p of p2) {
            p3.push(p);
        }
        return p3;
    }

    private static progressPercentageAccordedToChainCalculation = 50;

    /** paramétrage de la dichotomie */
    public dichoStartIntervalMaxSteps: number = 100;

    /** pointer to parent Nub */
    public parent: Nub;

Mathias Chouet's avatar
Mathias Chouet committed
36
37
38
39
40
41
42
    /** type of children elements, used by GUI for translation */
    protected _childrenType: string = "";

    public get childrenType(): string {
        return this._childrenType;
    }

Mathias Chouet's avatar
Mathias Chouet committed
43
44
    public get result(): Result {
        return this._result;
45
46
    }

47
48
49
50
51
52
    /**
     * Local setter to set results of Equation() / Solve() / …  as current
     * ResultElement, instead of overwriting the whole Result object
     * (used by CalcSerie with varying parameters)
     */
    protected set currentResult(r: Result) {
53
        // this.setCurrentResult(r);
54
55
56
        if (! this._result) {
            this.initNewResultElement();
        }
57
58
59
        this._result.resultElement = r.resultElement;
    }

60
    /** Returns Props object (observable set of key-values) associated to this Nub */
61
    public get properties(): Props {
Mathias Chouet's avatar
Mathias Chouet committed
62
63
        // completes props with calcType if not already set
        this._props.setPropValue("calcType", this.calcType);
Mathias Chouet's avatar
Mathias Chouet committed
64
65
66
        return this._props;
    }

67
    public set properties(props: Props) {
68
69
        // copy observers
        const observers = this._props.getObservers();
70
71
72
        // empty props
        this._props.reset();
        // restore observers
73
74
75
        for (const obs of observers) {
            this._props.addObserver(obs);
        }
76
77
78
79
        // set new props values
        for (const p of Object.keys(props.props)) {
            this._props.setPropValue(p, props.getPropValue(p));
        }
Mathias Chouet's avatar
Mathias Chouet committed
80
81
    }

Dorchies David's avatar
Dorchies David committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    /**
     * return ParamsEquation of all children recursively
     */
    public get childrenPrms(): ParamsEquation[] {
        const prms: ParamsEquation[] = [];
        if (this._children.length) { // if called within constructor, default class member value is not set yet
            for (const child of this._children) {
                prms.push(child.prms);
                if (child.getChildren()) {
                    if (child.getChildren().length) {
                        Nub.concatPrms(prms, child.childrenPrms);
                    }
                }
            }
        }
        return prms;
    }

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    /**
     * Returns an array with the calculable parameters
     */
    public get calculableParameters(): ParamDefinition[] {
        const calcPrms: ParamDefinition[] = [];
        for (const p of this.parameterIterator) {
            if (
                p.symbol !== "Pr" &&
                [ParamCalculability.DICHO, ParamCalculability.EQUATION].includes(p.calculability)
            ) {
                calcPrms.push(p);
            }
        }
        return calcPrms;
    }

Mathias Chouet's avatar
Mathias Chouet committed
116
117
118
119
120
121
122
123
    /**
     * Returns an iterator over :
     *  - own parameters (this._prms)
     *  - children parameters (this._children[*]._prms)
     */
    public get parameterIterator(): IParamDefinitionIterator {
        const prms: ParamsEquation[] = [];
        prms.push(this._prms);
Dorchies David's avatar
Dorchies David committed
124
125
        if (this._children) {
            Nub.concatPrms(prms, this.childrenPrms);
Mathias Chouet's avatar
Mathias Chouet committed
126
127
128
129
        }
        return new ParamsEquationArrayIterator(prms);
    }

130
131
132
133
134
    protected get progress() {
        return this._progress;
    }

    /**
135
136
     * Updates the progress percentage and notifies observers,
     * at most once per 300ms
137
138
139
     */
    protected set progress(v: number) {
        this._progress = v;
140
141
142
143
144
145
146
147
148
        const currentTime = new Date().getTime();
        if (
            (currentTime - this.previousNotificationTimestamp) > 30
            || v === 100
        ) {
            // console.log(">> notifying !");
            this.notifyProgressUpdated();
            this.previousNotificationTimestamp = currentTime;
        }
149
150
    }

151
    public get calcType(): CalculatorType {
Mathias Chouet's avatar
Mathias Chouet committed
152
        return this._calcType;
153
154
    }

Mathias Chouet's avatar
Mathias Chouet committed
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    public get calculatedParam(): ParamDefinition {
        return this._calculatedParam;
    }

    /**
     * Sets p as the parameter to be computed; sets it to CALC mode
     */
    public set calculatedParam(p: ParamDefinition) {
        this._calculatedParam = p;
        this._calculatedParam.valueMode = ParamValueMode.CALCUL;
    }

    /**
     * Returns a parameter descriptor compatible with Calc() methods,
     * ie. a symbol string for a Nub's main parameter, or an object
     * of the form { uid: , symbol: } for a Nub's sub-Nub parameter
     * (ex: Structure parameter in ParallelStructure)
     */
    public get calculatedParamDescriptor(): string | { uid: string, symbol: string } {
        if (this.uid === this._calculatedParam.nubUid) {
            return this._calculatedParam.symbol;
        } else {
            return {
                uid: this._calculatedParam.nubUid,
                symbol: this._calculatedParam.symbol
            };
        }
    }

Dorchies David's avatar
Dorchies David committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
    /** parameter that is to be computed by default - to be overloaded by child classes */
    protected _defaultCalculatedParam: ParamDefinition;

    /** parameter that is to be computed */
    protected _calculatedParam: ParamDefinition;

    /**
     * List of children Nubs; browsed by parameters iterator.
     *  - for ParallelStructures: contains 0 or more Structures
     *  - for SectionNub : contains exactly 1 acSection
     */
    protected _children: Nub[];

    /** properties describing the Nub type */
    protected _props: Props = new Props();

200
    /** résultat de Calc()/CalcSerie() */
201
    protected _result: Result;
202

Dorchies David's avatar
Dorchies David committed
203
204
205
206
207
208
209
210
211
    /** implémentation par délégation de IObservable */
    private _observable: Observable;

    /** a rough indication of calculation progress, between 0 and 100 */
    private _progress: number = 0;

    /** allows notifying of progress every X milliseconds only */
    private previousNotificationTimestamp = 0;

212
213
    private _firstAnalyticalPrmSymbol: string;

Dorchies David's avatar
Dorchies David committed
214
215
    public constructor(prms: ParamsEquation, dbg: boolean = false) {
        super(prms, dbg);
216
        this.deleteAllChildren();
Dorchies David's avatar
Dorchies David committed
217
218
219
220
221
        this._observable = new Observable();
        this._defaultCalculatedParam = this.getFirstAnalyticalParameter();
        this.resetDefaultCalculatedParam();
    }

Mathias Chouet's avatar
Mathias Chouet committed
222
    /**
223
224
225
226
     * Finds the previous calculated parameter and sets its mode to SINGLE
     */
    public unsetCalculatedParam(except: ParamDefinition) {
        for (const p of this.parameterIterator) {
227
228
229
230
            if (
                p.valueMode === ParamValueMode.CALCUL
                && p !== except
            ) {
231
232
233
234
235
236
237
238
239
240
                p.setValueMode(ParamValueMode.SINGLE, false);
            }
        }
    }

    /**
     * Tries to reset the calculated parameter, successively, to :
     *  - the default one if it is in SINGLE mode
     *  - the first SINGLE calculable parameter other than requirer
     *  - the first MINMAX/LISTE calculable parameter other than requirer
Dorchies David's avatar
Dorchies David committed
241
     *
Mathias Chouet's avatar
Mathias Chouet committed
242
243
244
245
246
247
248
     * If no default calculated parameter is defined, does nothing.
     */
    public resetDefaultCalculatedParam(requirer?: ParamDefinition) {
        if (this._defaultCalculatedParam) {
            // if default calculated param is not eligible to CALC mode
            if (
                requirer === this._defaultCalculatedParam
249
250
251
252
253
254
                || ! [
                        ParamValueMode.SINGLE,
                        ParamValueMode.MINMAX,
                        ParamValueMode.LISTE
                    ].includes(this._defaultCalculatedParam.valueMode
                )
Mathias Chouet's avatar
Mathias Chouet committed
255
            ) {
Mathias Chouet's avatar
Mathias Chouet committed
256
                // first SINGLE calculable parameter if any
257
                const newCalculatedParam = this.findFirstCalculableParameter(requirer);
Mathias Chouet's avatar
Mathias Chouet committed
258
259
260
                if (newCalculatedParam) {
                    this.calculatedParam = newCalculatedParam;
                } else {
261
                    // @TODO throws when a new linkable nub is added, and all parameters are already linked !
262
                    throw Error("resetDefaultCalculatedParam : could not find any SINGLE/MINMAX/LISTE parameter");
Mathias Chouet's avatar
Mathias Chouet committed
263
264
265
266
267
268
269
270
271
272
273
274
                }
            } else {
                // default one
                this.calculatedParam = this._defaultCalculatedParam;
            }
        } else {
            // do nothing (ex: Section Paramétrée)
        }
    }

    /**
     * Returns the first visible calculable parameter other than "Pr",
275
276
     * and other than otherThan, that is set to SINGLE, MINMAX or LISTE
     * mode (there might be none)
Mathias Chouet's avatar
Mathias Chouet committed
277
     */
278
    public findFirstCalculableParameter(otherThan?: ParamDefinition) {
Mathias Chouet's avatar
Mathias Chouet committed
279
280
        for (const p of this.parameterIterator) {
            if (
281
282
283
284
285
                [ ParamCalculability.EQUATION, ParamCalculability.DICHO ].includes(p.calculability)
                && p.symbol !== "Pr"
                && p.visible
                && p !== otherThan
                && [ ParamValueMode.SINGLE, ParamValueMode.MINMAX, ParamValueMode.LISTE ].includes(p.valueMode)
Mathias Chouet's avatar
Mathias Chouet committed
286
            ) {
287
                return p;
Mathias Chouet's avatar
Mathias Chouet committed
288
289
            }
        }
290
        return undefined;
Mathias Chouet's avatar
Mathias Chouet committed
291
292
    }

293
    /**
294
295
     * Formule utilisée pour le calcul analytique (solution directe ou méthode de résolution spécifique)
     */
296
    public abstract Equation(sVarCalc: string): Result;
297

298
    /**
299
     * Calculate and put in cache the symbol of first parameter calculable analytically
300
     */
301
    get firstAnalyticalPrmSymbol(): string {
302
303
304
        if (this._firstAnalyticalPrmSymbol === undefined) {
            this._firstAnalyticalPrmSymbol = this.getFirstAnalyticalParameter().symbol;
        }
305
306
307
308
309
310
311
312
313
        return this._firstAnalyticalPrmSymbol;
    }

    /**
     * Run Equation with first analytical parameter to compute
     * Returns the result in number form
     */
    public EquationFirstAnalyticalParameter(): number {
        return this.Equation(this.firstAnalyticalPrmSymbol).vCalc;
314
315
    }

316
    /**
317
318
     * Calcul d'une équation quelle que soit l'inconnue à calculer; déclenche le calcul en
     * chaîne des modules en amont si nécessaire
319
320
321
     * @param sVarCalc nom de la variable à calculer
     * @param rInit valeur initiale de la variable à calculer dans le cas de la dichotomie
     */
Mathias Chouet's avatar
Mathias Chouet committed
322
323
324
325
326
327
328
329
    public Calc(sVarCalc?: string, rInit?: number): Result {
        let computedVar;
        // overload calculated param at execution time ?
        if (sVarCalc) {
            computedVar = this.getParameter(sVarCalc);
        } else {
            computedVar = this.calculatedParam;
        }
330

331
        if (rInit === undefined) {
332
            rInit = computedVar.v;
333
        }
334
        if (computedVar.isAnalytical()) {
335
            this.currentResult = this.Equation(sVarCalc);
336
            this._result.symbol = sVarCalc;
337
            return this._result;
338
        }
339

340
        const resSolve: Result = this.Solve(sVarCalc, rInit);
341
        if (!resSolve.ok) {
342
            this.currentResult = resSolve;
343
            this._result.symbol = sVarCalc;
344
            return this._result;
345
346
        }
        const sAnalyticalPrm: string = this.getFirstAnalyticalParameter().symbol;
347
        computedVar.v = resSolve.vCalc;
348
349
        const res: Result = this.Equation(sAnalyticalPrm);
        res.vCalc = resSolve.vCalc;
350

351
        this.currentResult = res;
352
        this._result.symbol = sVarCalc;
353
354
355

        this.notifyResultUpdated();

356
        return this._result;
357
358
    }

359
    /**
360
361
     * Calculates required Nubs so that all input data is available;
     * uses 50% of the progress
362
     */
Mathias Chouet's avatar
Mathias Chouet committed
363
364
    public triggerChainCalculation() {
        const requiredNubs1stLevel = this.getRequiredNubs();
365
366
367
368
369
370
371
372
        if (requiredNubs1stLevel.length > 0) {
            const progressStep = Nub.progressPercentageAccordedToChainCalculation / requiredNubs1stLevel.length;
            for (const rn of requiredNubs1stLevel) {
                rn.CalcSerie();
                this.progress += progressStep;
            }
            // round progress to accorded percentage
            this.progress = Nub.progressPercentageAccordedToChainCalculation;
373
374
375
        }
    }

376
    /**
377
378
     * Effectue une série de calculs sur un paramètre; déclenche le calcul en chaîne
     * des modules en amont si nécessaire
379
     * @param rInit solution approximative du paramètre
380
     * @param sDonnee éventuel symbole / paire symbole-uid du paramètre à calculer
381
     */
382
    public CalcSerie(rInit?: number, sDonnee?: any): Result {
383
        // variated parameters caracteristics
384
        const variated: Array<{ param: ParamDefinition, values: ParamValues }> = [];
385

386
        // prepare calculation
387
        this.progress = 0;
Mathias Chouet's avatar
Mathias Chouet committed
388
        this.triggerChainCalculation();
389
        this.copySingleValuesToSandboxValues();
390
391

        // check which values are variating, if any
392
        for (const p of this.parameterIterator) {
393
394
395
396
397
398
399
400
401
402
403
404
405
            if (
                p.valueMode === ParamValueMode.LISTE
                || p.valueMode === ParamValueMode.MINMAX
                || (
                    p.valueMode === ParamValueMode.LINK
                    && p.isReferenceDefined()
                    && p.referencedValue.hasMultipleValues()
                )
            ) {
                variated.push({
                    param: p,
                    // extract variated values from variated Parameters
                    // (in LINK mode, proxies to target data)
406
                    values: p.paramValues
407
                });
408
409
410
            }
        }

411
        // find calculated parameter
412
        const computedSymbol = this.findCalculatedParameter(sDonnee);
413

414
        if (rInit === undefined && this.calculatedParam) {
Mathias Chouet's avatar
Mathias Chouet committed
415
            rInit = this.calculatedParam.v;
416
        }
417

418
419
420
        // reinit Result and children Results
        this.reinitResult();

421
        if (variated.length === 0) { // no parameter is varying
422
423
424
            // prepare a new slot to store results
            this.initNewResultElement();
            this.doCalc(computedSymbol, rInit); // résultat dans this.currentResult (resultElement le plus récent)
425
426
            this.progress = 100;

427
428
429
430
431
432
433
434
435
        } else { // at least one parameter is varying
            // find longest series
            let longest = 0;
            for (let i = 0; i < variated.length; i++) {
                if (variated[i].values.valuesIterator.count() > variated[longest].values.valuesIterator.count()) {
                    longest = i;
                }
            }
            const size = variated[longest].values.valuesIterator.count();
Mathias Chouet's avatar
Mathias Chouet committed
436

437
438
439
440
            // grant the remaining percentage of the progressbar to local calculation
            // (should be 50% if any chain calculation occurred, 100% otherwise)
            let progressStep;
            const remainingProgress = 100 - this.progress;
441
            progressStep = remainingProgress / size;
442

443
            // const res = new Result(undefined, this);
444

445
446
447
448
449
450
451
452
453
454
            // (re)init all iterators
            for (const v of variated) {
                if (v === variated[longest]) {
                    v.values.initValuesIterator(false);
                } else {
                    v.values.initValuesIterator(false, size);
                }
            }

            // iterate over longest series (in fact any series would do)
455
456
457
            while (variated[longest].values.hasNext) {
                // get next value for all variating parameters
                for (const v of variated) {
458
459
                    const currentIteratorValue = v.values.next();
                    v.param.v = currentIteratorValue.value;
460
                }
461
462
                // prepare a new slot to store results
                this.initNewResultElement();
463
                // calculate
464
465
                this.doCalc(computedSymbol, rInit); // résultat dans this.currentResult (resultElement le plus récent)
                if (this._result.resultElement.ok) {
466
                    rInit = this._result.resultElement.vCalc;
467
                }
468
469
                // update progress
                this.progress += progressStep;
470
            }
471
            // this._result = res;
472
473
            // round progress to 100%
            this.progress = 100;
474
475
        }

476
477
        if (computedSymbol !== undefined) {
            const realSymbol = (typeof computedSymbol === "string") ? computedSymbol : computedSymbol.symbol;
478
            this._result.symbol = realSymbol;
479
        }
480

481
482
        this.notifyResultUpdated();

483
        return this._result;
484
485
    }

Mathias Chouet's avatar
Mathias Chouet committed
486
487
488
489
490
491
492
493
494
495
    public addChild(child: Nub, after?: number) {
        if (after !== undefined) {
            this._children.splice(after + 1, 0, child);
        } else {
            this._children.push(child);
        }
        // add reference to parent collection (this)
        child.parent = this;
        // propagate precision
        child.prms.Pr.setValue(this.prms.Pr.v); // does not write to .v to bypass calculability control
Mathias Chouet's avatar
Fix #86    
Mathias Chouet committed
496
497
        // postprocessing
        this.adjustChildParameters(child);
Mathias Chouet's avatar
Mathias Chouet committed
498
    }
499
500

    public getChildren(): Nub[] {
Mathias Chouet's avatar
Mathias Chouet committed
501
        return this._children;
502
503
504
    }

    public getParent(): Nub {
Mathias Chouet's avatar
Mathias Chouet committed
505
        return this.parent;
506
507
    }

508
509
510
511
512
513
514
515
516
517
518
519
    /**
     * Returns true if all parameters are valid; used to check validity of
     * parameters linked to Nub results
     */
    public isComputable() {
        let valid = true;
        for (const p of this.prms) {
            valid = valid && p.isValid;
        }
        return valid;
    }

520
521
522
523
524
    /**
     * Liste des valeurs (paramètre, résultat, résultat complémentaire) liables à un paramètre
     * @param src paramètre auquel lier d'autres valeurs
     */
    public getLinkableValues(src: ParamDefinition): LinkedValue[] {
525
        let res: LinkedValue[] = [];
526
527
        const symbol = src.symbol;

528
529
530
531
        // If parameter comes from the same Nub, its parent or any of its children,
        // no linking is possible at all.
        // Different Structures in the same parent can get linked to each other.
        if (! this.isParentOrChildOf(src.nubUid)) {
532

Mathias Chouet's avatar
Mathias Chouet committed
533
            // 1. own parameters
534
535
536
537
538
539
            for (const p of this._prms) {
                // if symbol and Nub type are identical, or if family is identical
                if (
                    (p.symbol === symbol && this.calcType === src.nubCalcType)
                    || (p.family !== undefined && (p.family === src.family))
                ) {
540
541
                    // if it is safe to link p's value to src
                    if (p.isLinkableTo(src)) {
Mathias Chouet's avatar
Mathias Chouet committed
542
                        // if p is a CALC param of a Structure other than "Q"
543
                        // (structures always have Q as CALC param and cannot have another)
Mathias Chouet's avatar
Mathias Chouet committed
544
545
                        // or a CALC param of a Section, that is not sibling of the target
                        // (to prevent circular dependencies among ParallelStructures),
Mathias Chouet's avatar
Mathias Chouet committed
546
                        // expose its parent
547
                        if (
Mathias Chouet's avatar
Mathias Chouet committed
548
                            (
Mathias Chouet's avatar
Mathias Chouet committed
549
                              (this instanceof Structure && p.symbol !== "Q" && ! this.isSiblingOf(src.nubUid))
Mathias Chouet's avatar
Mathias Chouet committed
550
551
                              || this instanceof acSection
                            )
552
553
                            && (p.valueMode === ParamValueMode.CALCUL)
                        ) {
Mathias Chouet's avatar
Mathias Chouet committed
554
                            // trick to expose p as a result of the parent Nub
555
556
                            res.push(new LinkedValue(this.parent, p, p.symbol));
                        } else {
557
558
559
560
                            // do not suggest parameters that are already linked to another one
                            if (p.valueMode !== ParamValueMode.LINK) {
                                res.push(new LinkedValue(this, p, p.symbol));
                            }
561
                        }
562
563
564
                    }
                }
            }
565

566
            // 2. extra results
567
            if (this._resultsFamilies) {
568
                // if I don't depend on your result, you may depend on mine !
Mathias Chouet's avatar
Mathias Chouet committed
569
                if (! this.dependsOnNubResult(src.parentNub)) {
570
                    const erk = Object.keys(this._resultsFamilies);
571
                    // browse extra results
572
                    for (const erSymbol of erk) {
573
                        const erFamily = this._resultsFamilies[erSymbol];
574
575
576
577
578
579
                        // if family is identical
                        if (erFamily === src.family) {
                            res.push(new LinkedValue(this, undefined, erSymbol));
                        }
                    }
                }
580
581
            }
        }
582

583
584
        // 3. children Nubs, except for PAB and MRC
        if (! (this instanceof Pab || this instanceof MacrorugoCompound)) {
585
586
587
            for (const cn of this.getChildren()) {
                res = res.concat(cn.getLinkableValues(src));
            }
588
589
        }

590
        return res;
591
    }
592

593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
    /**
     * Returns true if the given Nub UID is either of :
     *  - the current Nub UID
     *  - the current Nub's parent Nub UID
     *  - the UID of any of the current Nub's children
     */
    public isParentOrChildOf(uid: string): boolean {
        if (this.uid === uid) {
            return true;
        }
        const parent = this.getParent();
        if (parent && parent.uid === uid) {
            return true;
        }
        for (const c of this.getChildren()) {
            if (c.uid === uid) {
                return true;
            }
        }
        return false;
    }

Mathias Chouet's avatar
Mathias Chouet committed
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
    /**
     * Returns true if the given Nub UID :
     *  - is the current Nub UID
     *  - is the UID of any of the current Nub's siblings (children of the same parent)
     */
    public isSiblingOf(uid: string): boolean {
        if (this.uid === uid) {
            return true;
        }
        const parent = this.getParent();
        if (parent) {
            for (const c of parent.getChildren()) {
                if (c.uid === uid) {
                    return true;
                }
            }
            return true;
        }
        return false;
    }

Mathias Chouet's avatar
Mathias Chouet committed
636
637
638
639
640
641
    /**
     * Returns all Nubs whose results are required by the given one,
     * without following links (stops when it finds a Nub that has to
     * be calculated). Used to trigger chain calculation.
     */
    public getRequiredNubs(visited: string[] = []) {
Mathias Chouet's avatar
Mathias Chouet committed
642
        const requiredNubs: Nub[] = [];
Mathias Chouet's avatar
Mathias Chouet committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
        // prevent loops
        if (! visited.includes(this.uid)) {
            visited.push(this.uid);

            // inspect all target Nubs
            for (const p of this.parameterIterator) {
                if (p.valueMode === ParamValueMode.LINK && p.isReferenceDefined()) {
                    const nub = p.referencedValue.nub;

                    // a Nub is required if I depend on its result
                    if (this.dependsOnNubResult(nub, false)) {
                        requiredNubs.push(nub);
                    }
                }
            }
        }
        return requiredNubs;
    }

662
    /**
663
     * Returns all Nubs whose parameters or results are targetted
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
     * by the given one.
     * (used for dependencies checking at session saving time)
     */
    public getTargettedNubs(visited: string[] = []) {
        const targettedNubs: Nub[] = [];
        // prevent loops
        if (! visited.includes(this.uid)) {
            visited.push(this.uid);

            // inspect all target Nubs
            for (const p of this.parameterIterator) {
                if (p.valueMode === ParamValueMode.LINK && p.isReferenceDefined()) {
                    targettedNubs.push(p.referencedValue.nub);
                }
            }
        }
        return targettedNubs;
    }

683
    /**
684
685
686
687
688
689
690
691
692
693
     * Returns true if
     *  - this Nub
     *  - any of this Nub's children
     *  - this Nub's parent
     * depends on
     *  - the result of the given Nub
     *  - the result of any of the given Nub's children
     *  - the result of the given Nub's parent
     *
     * (ie. "my family depends on the result of your family")
Mathias Chouet's avatar
Mathias Chouet committed
694
695
     *
     * If followLinksChain is false, will limit the exploration to the first target level only
696
     */
Mathias Chouet's avatar
Mathias Chouet committed
697
    public dependsOnNubResult(nub: Nub, followLinksChain: boolean = true): boolean {
698
699
700
701
702
703
704
        let thisFamily: Nub[] = [this];
        const tp = this.getParent();
        if (tp) {
            thisFamily = thisFamily.concat(tp);
        }
        thisFamily = thisFamily.concat(this.getChildren());

705
        let yourFamily: Nub[] = [];
Mathias Chouet's avatar
Mathias Chouet committed
706
        const you = nub;
707
708
709
710
711
712
713
        if (you) {
            yourFamily = [you];
            const yp = you.getParent();
            if (yp) {
                yourFamily = yourFamily.concat(yp);
            }
            yourFamily = yourFamily.concat(you.getChildren());
714
715
716
717
718
719
720
721
722
        }

        let depends = false;

        outerloop:
        for (const t of thisFamily) {
            // look for a parameter linked to the result of any Nub of yourFamily
            for (const p of t.prms) {
                if (p.valueMode === ParamValueMode.LINK) {
Mathias Chouet's avatar
Mathias Chouet committed
723
                    if (p.isLinkedToResultOfNubs(yourFamily, followLinksChain)) {
724
725
726
727
728
729
730
731
732
733
734
                        // dependence found !
                        depends = true;
                        break outerloop;
                    }
                }
            }
        }

        return depends;
    }

735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
    /**
     * Returns true if this nub (parent and children included)
     * directly requires (1st level only) @TODO follow links ?
     * the given parameter
     */
    public dependsOnParameter(src: ParamDefinition) {
        let thisFamily: Nub[] = [this];
        const tp = this.getParent();
        if (tp) {
            thisFamily = thisFamily.concat(tp);
        }
        thisFamily = thisFamily.concat(this.getChildren());

        let depends = false;

        outerloop:
        for (const t of thisFamily) {
            // look for a parameter of thisFamily that is directly linked to src
            for (const p of t.prms) {
                if (
                    p.valueMode === ParamValueMode.LINK
                    && p.isReferenceDefined()
                    && p.referencedValue.isParameter()
                ) {
                    if (
                        p.referencedValue.nub.uid === src.nubUid
                        && p.referencedValue.symbol === src.symbol
                    ) {
                        // dependence found !
                        depends = true;
                        break outerloop;
                    }
                }
            }
        }

        return depends;
    }

774
775
776
777
    /**
     * Returns true if the computation of the current Nub (parent and children
     * included) directly requires (1st level only), anything (parameter or result)
     * from the given Nub UID "uid", its parent or any of its children
778
     * @param uid
779
780
781
782
     * @param symbol symbol of the target parameter whose value change triggered this method;
     *      if current Nub targets this symbol, it will be considered dependent
     * @param includeValuesLinks if true, even if this Nub targets only non-calculated non-modified
     *      parameters, it will be considered dependent @see jalhyd#98
783
     */
784
785
786
787
788
789
    public resultDependsOnNub(
        uid: string,
        visited: string[] = [],
        symbol?: string,
        includeValuesLinks: boolean = false
    ): boolean {
790
791
792
793
794
795
        if (uid !== this.uid && ! visited.includes(this.uid)) {
            visited.push(this.uid);

            // does any of our parameters depend on the target Nub ?
            for (const p of this._prms) {
                if (p.valueMode === ParamValueMode.LINK) {
796
                    if (p.dependsOnNubFamily(uid, symbol, includeValuesLinks)) {
797
798
799
800
801
802
803
                        return true;
                    }
                }
            }
            // does any of our parent's parameters depend on the target Nub ?
            const parent = this.getParent();
            if (parent) {
804
                if (parent.resultDependsOnNub(uid, visited, symbol, includeValuesLinks)) {
805
806
807
808
809
                    return true;
                }
            }
            // does any of our children' parameters depend on the target Nub ?
            for (const c of this.getChildren()) {
810
                if (c.resultDependsOnNub(uid, visited, symbol, includeValuesLinks)) {
811
                    return true;
812
                }
813
            }
814
        }
815
816
        return false;
    }
817

818
819
820
821
822
823
    /**
     * Returns true if the computation of the current Nub has multiple values
     * (whether it is already computed or not), by detecting if any parameter,
     * linked or not, is variated
     */
    public resultHasMultipleValues(): boolean {
824
        let hmv = false;
Mathias Chouet's avatar
Mathias Chouet committed
825
        for (const p of this.parameterIterator) {
826
            if (p.valueMode === ParamValueMode.MINMAX || p.valueMode === ParamValueMode.LISTE) {
827
                hmv = true;
Mathias Chouet's avatar
Mathias Chouet committed
828
            } else if (p.valueMode === ParamValueMode.LINK && p.isReferenceDefined()) {
829
                // indirect recursivity
830
                hmv = hmv || p.referencedValue.hasMultipleValues();
831
            }
832
        }
833
        return hmv;
834
    }
835

836
837
    /**
     * Sets the current result to undefined, as well as the results
Mathias Chouet's avatar
Mathias Chouet committed
838
839
     * of all depending Nubs; also invalidates all fake ParamValues
     * held by LinkedValues pointing to this result
840
     */
841
    public resetResult(visited: string[] = []) {
842
        this._result = undefined;
843
        visited.push(this.uid);
844
845
        const dependingNubs = Session.getInstance().getDependingNubs(this.uid);
        for (const dn of dependingNubs) {
846
847
848
            if (! visited.includes(dn.uid)) {
                dn.resetResult(visited);
            }
Mathias Chouet's avatar
Mathias Chouet committed
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
            dn.resetLinkedParamValues(this);
        }
    }

    /**
     * For all parameters pointing to the result of the given Nub,
     * invalidates fake ParamValues held by pointed LinkedValue
     */
    public resetLinkedParamValues(nub: Nub) {
        for (const p of this.parameterIterator) {
            if (p.valueMode === ParamValueMode.LINK && p.isReferenceDefined()) {
                if (
                    (p.referencedValue.isResult() || p.referencedValue.isExtraResult())
                    && p.referencedValue.nub.uid === nub.uid
                ) {
                    p.referencedValue.invalidateParamValues();
                }
            }
867
868
869
        }
    }

870
871
872
    /**
     * Returns a JSON representation of the Nub's current state
     * @param extra extra key-value pairs, for ex. calculator title in GUI
873
874
875
     * @param nubUidsInSession UIDs of Nubs that will be saved in session along with this one;
     *                         useful to determine if linked parameters must be kept as links
     *                         or have their value copied (if target is not in UIDs list)
876
     */
877
878
    public serialise(extra?: object, nubUidsInSession?: string[]) {
        return JSON.stringify(this.objectRepresentation(extra, nubUidsInSession));
879
880
881
882
883
    }

    /**
     * Returns an object representation of the Nub's current state
     * @param extra extra key-value pairs, for ex. calculator title in GUI
884
885
886
     * @param nubUidsInSession UIDs of Nubs that will be saved in session along with this one;
     *                         useful to determine if linked parameters must be kept as links
     *                         or have their value copied (if target is not in UIDs list)
887
     */
888
    public objectRepresentation(extra?: object, nubUidsInSession?: string[]): object {
889
890
        let ret: any = {
            uid: this.uid,
891
            props: Session.invertEnumKeysAndValuesInProperties(this.properties.props),
892
        };
Mathias Chouet's avatar
Mathias Chouet committed
893

894
895
896
        if (extra) {
            ret =  {...ret, ...{ meta: extra } }; // merge properties
        }
Mathias Chouet's avatar
Mathias Chouet committed
897
        ret = {...ret, ...{  children: [], parameters: [] } }; // extend here to make "parameters" the down-most key
898

Mathias Chouet's avatar
Mathias Chouet committed
899
900
901
        // iterate over local parameters
        const localParametersIterator =  new ParamsEquationArrayIterator([this._prms]);
        for (const p of localParametersIterator) {
902
            if (p.visible) {
903
                ret.parameters.push(p.objectRepresentation(nubUidsInSession));
904
905
906
            }
        }

Mathias Chouet's avatar
Mathias Chouet committed
907
908
        // iterate over children Nubs
        for (const child of this._children) {
909
            ret.children.push(child.objectRepresentation(undefined, nubUidsInSession));
Mathias Chouet's avatar
Mathias Chouet committed
910
911
        }

912
913
914
        return ret;
    }

915
916
917
    /**
     * Fills the current Nub with parameter values, provided an object representation
     * @param obj object representation of a Nub content (parameters)
Mathias Chouet's avatar
Mathias Chouet committed
918
919
     * @returns the calculated parameter found, if any - used by child Nub to notify
     *          its parent of the calculated parameter to set
920
     */
921
922
923
924
925
926
    public loadObjectRepresentation(obj: any): { p: ParamDefinition, hasErrors: boolean } {
        // return value
        const ret: { p: ParamDefinition, hasErrors: boolean } = {
            p: undefined,
            hasErrors: false
        };
927
928
929
930
        // set parameter modes and values
        if (obj.parameters && Array.isArray(obj.parameters)) {
            for (const p of obj.parameters) {
                const param = this.getParameter(p.symbol);
931
932
933
934
935
936
937
938
939
940
941
                if (param) {
                    // load parameter
                    const pRet = param.loadObjectRepresentation(p, false);
                    if (pRet.calculated) {
                        ret.p = param;
                    }
                    // forward errors
                    if (pRet.hasErrors) {
                        ret.hasErrors = true;
                    }
                } else {
942
                    // tslint:disable-next-line:no-console
943
944
                    console.error(`session file : cannot find parameter ${p.symbol} in target Nub`);
                    ret.hasErrors = true;
945
946
                }
            }
Mathias Chouet's avatar
Mathias Chouet committed
947
            // define calculated param at Nub level
948
            // @TODO except if we are a Section / Structure / Cloisons ?
949
950
            if (ret.p) {
                this.calculatedParam = ret.p;
Mathias Chouet's avatar
Mathias Chouet committed
951
            }
952
        }
Mathias Chouet's avatar
Mathias Chouet committed
953
954
955
956

        // iterate over children if any
        if (obj.children && Array.isArray(obj.children)) {
            for (const s of obj.children) {
957
958
                // decode properties
                const props = Session.invertEnumKeysAndValuesInProperties(s.props, true);
Mathias Chouet's avatar
Mathias Chouet committed
959
                // create the Nub
960
                const subNub = Session.getInstance().createNub(new Props(props), this);
Mathias Chouet's avatar
Mathias Chouet committed
961
962
963
964
                // try to keep the original ID
                if (! Session.getInstance().uidAlreadyUsed(s.uid)) {
                    subNub.setUid(s.uid);
                }
965
                const childRet = subNub.loadObjectRepresentation(s);
Mathias Chouet's avatar
Mathias Chouet committed
966
                // add Structure to parent
967
                this.addChild(subNub);
Mathias Chouet's avatar
Mathias Chouet committed
968
                // set calculated parameter for child ?
969
970
971
972
973
974
                if (childRet.p) {
                    this.calculatedParam = childRet.p;
                }
                // forward errors
                if (childRet.hasErrors) {
                    ret.hasErrors = true;
Mathias Chouet's avatar
Mathias Chouet committed
975
976
977
978
                }
            }
        }

979
        return ret;
980
981
    }

982
983
984
985
    /**
     * Once session is loaded, run a second pass on all linked parameters to
     * reset their target if needed
     */
986
987
988
989
990
    public fixLinks(obj: any): { hasErrors: boolean } {
        // return value
        const ret = {
            hasErrors: false
        };
991
992
993
994
995
996
997
998
        if (obj.parameters && Array.isArray(obj.parameters)) {
            for (const p of obj.parameters) {
                const mode: ParamValueMode = (ParamValueMode as any)[p.mode]; // get enum index for string value
                if (mode === ParamValueMode.LINK) {
                    const param = this.getParameter(p.symbol);
                    // formulaire dont le Nub est la cible du lien
                    const destNub = Session.getInstance().findNubByUid(p.targetNub);
                    if (destNub) {
Mathias Chouet's avatar
Fix #89    
Mathias Chouet committed
999
1000
1001
                        try {
                            param.defineReference(destNub, p.targetParam);
                        } catch (err) {
1002
                            // tslint:disable-next-line:no-console
Mathias Chouet's avatar
Fix #95    
Mathias Chouet committed
1003
1004
                            console.error(`fixLinks: defineReference error`
                                + ` (${this.uid}.${param.symbol} => ${destNub.uid}.${p.targetParam})`);
1005
1006
                            // forward error
                            ret.hasErrors = true;
Mathias Chouet's avatar
Fix #89    
Mathias Chouet committed
1007
                        }
1008
                    } else {
1009
                        // tslint:disable-next-line:no-console
1010
                        console.error("fixLinks : cannot find target Nub");
1011
1012
                        // forward error
                        ret.hasErrors = true;
1013
1014
1015
1016
                    }
                }
            }
        }
1017
        return ret;
1018
1019
    }

Mathias Chouet's avatar
Mathias Chouet committed
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
    /**
     * Replaces a child Nub
     * @param index index of child in _children array
     * @param child new child
     * @param resetCalcParam if true, resets default calculated parameter after replacing child
     * @param keepParametersState if true, mode and value of parameters will be kept between old and new section
     */
    public replaceChild(index: number, child: Nub, resetCalcParam: boolean = false,
                        keepParametersState: boolean = true
    ) {
        if (index > -1 && index < this._children.length) {
            const hasOldChild = (this._children[index] !== undefined);
            const parametersState: any = {};

            // store old parameters state
            if (keepParametersState && hasOldChild) {
                for (const p of this._children[index].parameterIterator) {
                    parametersState[p.symbol] = p.objectRepresentation();
                }
            }

            // replace child
            this._children[index] = child;

            // reapply parameters state
            if (keepParametersState && hasOldChild) {
                for (const p of this._children[index].parameterIterator) {
                    if (p.symbol in parametersState) {
                        p.loadObjectRepresentation(parametersState[p.symbol]);
                    }
                }
            }
        } else {
            throw new Error(`${this.constructor.name}.replaceChild invalid index ${index}`
                          + ` (children length: ${this._children.length})`);
        }
1056
1057
1058
        // postprocessing
        this.adjustChildParameters(child);
        // ensure one parameter is calculated
Mathias Chouet's avatar
Mathias Chouet committed
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
        if (resetCalcParam) {
            this.resetDefaultCalculatedParam();
        }
        // add reference to parent collection (this)
        child.parent = this;
    }

    /**
     * Finds oldChild in the list, and replaces it at the same index with newChild;
     * if the current calculated parameter belonged to the old child, resets a default one
     * @param oldChild child to get the index for
     * @param newChild child to set at this index
     */
    public replaceChildInplace(oldChild: Nub, newChild: Nub) {
        const calcParamLost = (
            typeof this.calculatedParamDescriptor !== "string"
            && this.calculatedParamDescriptor.uid === oldChild.uid
        );
        const index = this.getIndexForChild(oldChild);
        if (index === -1) {
            throw new Error("old child not found");
        }
        this.replaceChild(index, newChild, calcParamLost);
1082
    }
Mathias Chouet's avatar
Mathias Chouet committed
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115

    /**
     * Returns the current index of the given child if any,
     * or else returns -1
     * @param child child or child UID to look for
     */
    public getIndexForChild(child: Nub | string): number {
        let index: number = -1;
        const uid = (child instanceof Nub) ? child.uid : child;
        for (let i = 0; i < this._children.length; i++) {
            if (this._children[i].uid === uid) {
                index = i;
            }
        }
        return index;
    }

    /**
     * @return true if given Nub id a child of current Nub
     */
    public hasChild(child: Nub): boolean {
        return this.hasChildUid(child.uid);
    }

    /**
     * @return true if given Nub uid id a child of current Nub
     */
    public hasChildUid(childUid: string): boolean {
        for (const s of this._children) {
            if (s.uid === childUid) {
                return true;
            }
        }
1116
1117
1118
        return false;
    }

1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
    /**
     * @return child having the given UID
     */
    public getChild(uid: string): Nub {
        for (const s of this._children) {
            if (s.uid === uid) {
                return s;
            }
        }
        return undefined;
    }

Mathias Chouet's avatar
Mathias Chouet committed
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
    /**
     * Moves a child to first position
     */
    public moveChildUp(child: Nub) {
        let i = 0;
        for (const s of this._children) {
            if (s.uid === child.uid && i > 0) {
                const t = this._children[i - 1];
                this._children[i - 1] = this._children[i];
                this._children[i] = t;
                return;
            }
            i++;
        }
    }

    /**
     * Moves a child to last position
     */
    public moveChildDown(child: Nub) {
        let i = 0;
        for (const s of this._children) {
            if (s.uid === child.uid && i < this._children.length - 1) {
                const t = this._children[i];
                this._children[i] = this._children[i + 1];
                this._children[i + 1] = t;
                return;
            }
            i++;
        }
    }

    /**
     * Removes a child
     * @param index
     */
    public deleteChild(index: number) {
        if (index > -1) {
            this._children.splice(index, 1);
        } else {
            throw new Error(`${this.constructor.name}.deleteChild invalid index=${index}`);
        }
    }

1175
1176
1177
1178
1179
    /** Removes all children */
    public deleteAllChildren() {
        this._children = [];
    }

Mathias Chouet's avatar
Mathias Chouet committed
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    /**
     * Returns the position or the current structure (starting at 0)
     * in the parent Nub
     */
    public findPositionInParent(): number {
        if (this.parent) {
            return this.parent.getIndexForChild(this);
        }
        throw new Error(`Nub of class ${this.constructor.name} has no parent`);
    }

1191
    /**
1192
     * Adds a new empty ResultElement to the current Result object, so that
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
     * computation result is stored into it, via set currentResult(); does
     * the same for all children
     */
    public initNewResultElement() {
        if (! this._result) {
            this._result = new Result(undefined, this);
        }
        // push empty result element for further affectation va set currentResult()
        this._result.addResultElement(new ResultElement());
        // do the same for children
        for (const c of this._children) {
            c.initNewResultElement();
        }
    }

1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
    /**
     * Sets this._result to a new empty Result, before starting a new CalcSerie();
     * does the same for all children
     */
    public reinitResult() {
        this._result = new Result(undefined, this);
        for (const c of this._children) {
            c.reinitResult();
        }
    }

1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
    // interface IObservable

    /**
     * ajoute un observateur à la liste
     */
    public addObserver(o: Observer) {
        this._observable.addObserver(o);
    }

    /**
     * supprime un observateur de la liste
     */
    public removeObserver(o: Observer) {
        this._observable.removeObserver(o);
    }

    /**
     * notifie un événement aux observateurs
     */
    public notifyObservers(data: