nub.ts 45.7 KB
Newer Older
1
import { CalculatorType, ComputeNode } from "./compute-node";
2
import { Dichotomie } from "./dichotomie";
3
4
import { acSection, IParamDefinitionIterator, Pab, ParamDefinition, ParamsEquation,
         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

Mathias Chouet's avatar
Mathias Chouet committed
20
21
    public get result(): Result {
        return this._result;
22
23
    }

24
25
26
27
28
29
    /**
     * 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) {
30
        // this.setCurrentResult(r);
31
32
33
        if (! this._result) {
            this.initNewResultElement();
        }
34
35
36
        this._result.resultElement = r.resultElement;
    }

37
    /** Returns Props object (observable set of key-values) associated to this Nub */
38
    public get properties(): Props {
Mathias Chouet's avatar
Mathias Chouet committed
39
40
        // completes props with calcType if not already set
        this._props.setPropValue("calcType", this.calcType);
Mathias Chouet's avatar
Mathias Chouet committed
41
42
43
        return this._props;
    }

44
45
    public set properties(props: Props) {
        this._props = props.clone();
Mathias Chouet's avatar
Mathias Chouet committed
46
47
    }

Dorchies David's avatar
Dorchies David committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    /**
     * 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;
    }

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    /**
     * Returns an array with the calculable parameters
     */
    public get calculableParameters(): ParamDefinition[] {
        const calcPrms: ParamDefinition[] = [];
        for (const p of this.parameterIterator) {
            if (
                p.symbol !== "Pr" &&
                p.visible &&
                [ParamCalculability.DICHO, ParamCalculability.EQUATION].includes(p.calculability)
            ) {
                calcPrms.push(p);
            }
        }
        return calcPrms;
    }

Mathias Chouet's avatar
Mathias Chouet committed
83
84
85
86
87
88
89
90
    /**
     * 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
91
92
        if (this._children) {
            Nub.concatPrms(prms, this.childrenPrms);
Mathias Chouet's avatar
Mathias Chouet committed
93
94
95
96
        }
        return new ParamsEquationArrayIterator(prms);
    }

97
98
99
100
101
    protected get progress() {
        return this._progress;
    }

    /**
102
103
     * Updates the progress percentage and notifies observers,
     * at most once per 300ms
104
105
106
     */
    protected set progress(v: number) {
        this._progress = v;
107
108
109
110
111
112
113
114
115
        const currentTime = new Date().getTime();
        if (
            (currentTime - this.previousNotificationTimestamp) > 30
            || v === 100
        ) {
            // console.log(">> notifying !");
            this.notifyProgressUpdated();
            this.previousNotificationTimestamp = currentTime;
        }
116
117
    }

118
    public get calcType(): CalculatorType {
Mathias Chouet's avatar
Mathias Chouet committed
119
        return this._calcType;
120
121
    }

Mathias Chouet's avatar
Mathias Chouet committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    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
            };
        }
    }

151
    protected static concatPrms(p1: ParamsEquation[], p2: ParamsEquation[]): ParamsEquation[] {
Dorchies David's avatar
Dorchies David committed
152
153
154
155
156
157
158
        const p3: ParamsEquation[] = p1;
        for (const p of p2) {
            p3.push(p);
        }
        return p3;
    }

159
160
    private static progressPercentageAccordedToChainCalculation = 50;

Dorchies David's avatar
Dorchies David committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
    /** paramétrage de la dichotomie */
    public dichoStartIntervalMaxSteps: number = 100;

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

    /** 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();

183
    /** résultat de Calc()/CalcSerie() */
184
    protected _result: Result;
185

Dorchies David's avatar
Dorchies David committed
186
187
188
189
190
191
192
193
194
    /** 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;

195
196
    private _firstAnalyticalPrmSymbol: string;

Dorchies David's avatar
Dorchies David committed
197
198
199
200
201
202
203
204
    public constructor(prms: ParamsEquation, dbg: boolean = false) {
        super(prms, dbg);
        this._children = [];
        this._observable = new Observable();
        this._defaultCalculatedParam = this.getFirstAnalyticalParameter();
        this.resetDefaultCalculatedParam();
    }

Mathias Chouet's avatar
Mathias Chouet committed
205
    /**
206
207
208
209
     * Finds the previous calculated parameter and sets its mode to SINGLE
     */
    public unsetCalculatedParam(except: ParamDefinition) {
        for (const p of this.parameterIterator) {
210
211
212
213
            if (
                p.valueMode === ParamValueMode.CALCUL
                && p !== except
            ) {
214
215
216
217
218
219
220
221
222
223
                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
224
     *
Mathias Chouet's avatar
Mathias Chouet committed
225
226
227
228
229
230
231
     * 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
232
233
234
235
236
237
                || ! [
                        ParamValueMode.SINGLE,
                        ParamValueMode.MINMAX,
                        ParamValueMode.LISTE
                    ].includes(this._defaultCalculatedParam.valueMode
                )
Mathias Chouet's avatar
Mathias Chouet committed
238
            ) {
Mathias Chouet's avatar
Mathias Chouet committed
239
                // first SINGLE calculable parameter if any
240
                const newCalculatedParam = this.findFirstCalculableParameter(requirer);
Mathias Chouet's avatar
Mathias Chouet committed
241
242
243
                if (newCalculatedParam) {
                    this.calculatedParam = newCalculatedParam;
                } else {
244
                    // @TODO throws when a new linkable nub is added, and all parameters are already linked !
245
                    throw Error("resetDefaultCalculatedParam : could not find any SINGLE/MINMAX/LISTE parameter");
Mathias Chouet's avatar
Mathias Chouet committed
246
247
248
249
250
251
252
253
254
255
256
257
                }
            } else {
                // default one
                this.calculatedParam = this._defaultCalculatedParam;
            }
        } else {
            // do nothing (ex: Section Paramétrée)
        }
    }

    /**
     * Returns the first visible calculable parameter other than "Pr",
258
259
     * and other than otherThan, that is set to SINGLE, MINMAX or LISTE
     * mode (there might be none)
Mathias Chouet's avatar
Mathias Chouet committed
260
     */
261
    public findFirstCalculableParameter(otherThan?: ParamDefinition) {
Mathias Chouet's avatar
Mathias Chouet committed
262
263
        for (const p of this.parameterIterator) {
            if (
264
265
266
267
268
                [ 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
269
            ) {
270
                return p;
Mathias Chouet's avatar
Mathias Chouet committed
271
272
            }
        }
273
        return undefined;
Mathias Chouet's avatar
Mathias Chouet committed
274
275
    }

276
    /**
277
278
     * Formule utilisée pour le calcul analytique (solution directe ou méthode de résolution spécifique)
     */
279
    public abstract Equation(sVarCalc: string): Result;
280

281
    /**
282
     * Calculate and put in cache the symbol of first parameter calculable analytically
283
     */
284
    get firstAnalyticalPrmSymbol(): string {
285
286
287
        if (this._firstAnalyticalPrmSymbol === undefined) {
            this._firstAnalyticalPrmSymbol = this.getFirstAnalyticalParameter().symbol;
        }
288
289
290
291
292
293
294
295
296
        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;
297
298
    }

299
    /**
300
301
     * Calcul d'une équation quelle que soit l'inconnue à calculer; déclenche le calcul en
     * chaîne des modules en amont si nécessaire
302
303
304
     * @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
305
306
307
308
309
310
311
312
    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;
        }
313

314
        if (rInit === undefined) {
315
            rInit = computedVar.v;
316
        }
317
        if (computedVar.isAnalytical()) {
318
            this.currentResult = this.Equation(sVarCalc);
319
            this._result.symbol = sVarCalc;
320
            return this._result;
321
        }
322

323
        const resSolve: Result = this.Solve(sVarCalc, rInit);
324
        if (!resSolve.ok) {
325
            this.currentResult = resSolve;
326
            this._result.symbol = sVarCalc;
327
            return this._result;
328
329
        }
        const sAnalyticalPrm: string = this.getFirstAnalyticalParameter().symbol;
330
        computedVar.v = resSolve.vCalc;
331
332
        const res: Result = this.Equation(sAnalyticalPrm);
        res.vCalc = resSolve.vCalc;
333

334
        this.currentResult = res;
335
        this._result.symbol = sVarCalc;
336
337
338

        this.notifyResultUpdated();

339
        return this._result;
340
341
    }

342
    /**
343
344
     * Calculates required Nubs so that all input data is available;
     * uses 50% of the progress
345
     */
Mathias Chouet's avatar
Mathias Chouet committed
346
347
    public triggerChainCalculation() {
        const requiredNubs1stLevel = this.getRequiredNubs();
348
349
350
351
352
353
354
355
        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;
356
357
358
        }
    }

359
    /**
360
361
     * Effectue une série de calculs sur un paramètre; déclenche le calcul en chaîne
     * des modules en amont si nécessaire
362
     * @param rInit solution approximative du paramètre
363
     * @param sDonnee éventuel symbole / paire symbole-uid du paramètre à calculer
364
     */
365
    public CalcSerie(rInit?: number, sDonnee?: any): Result {
366
        // variated parameters caracteristics
367
        const variated: Array<{ param: ParamDefinition, values: ParamValues }> = [];
368

369
        // prepare calculation
370
        this.progress = 0;
Mathias Chouet's avatar
Mathias Chouet committed
371
        this.triggerChainCalculation();
372
        this.copySingleValuesToSandboxValues();
373
374

        // check which values are variating, if any
375
        for (const p of this.parameterIterator) {
376
377
378
379
380
381
382
383
384
385
386
387
388
            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)
389
                    values: p.paramValues
390
                });
391
392
393
            }
        }

394
        // find calculated parameter
395
        const computedSymbol = this.findCalculatedParameter(sDonnee);
396

397
        if (rInit === undefined && this.calculatedParam) {
Mathias Chouet's avatar
Mathias Chouet committed
398
            rInit = this.calculatedParam.v;
399
        }
400

401
402
403
        // reinit Result and children Results
        this.reinitResult();

404
        if (variated.length === 0) { // no parameter is varying
405
406
407
            // prepare a new slot to store results
            this.initNewResultElement();
            this.doCalc(computedSymbol, rInit); // résultat dans this.currentResult (resultElement le plus récent)
408
409
            this.progress = 100;

410
411
412
413
414
415
416
417
418
        } 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
419

420
421
422
423
            // 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;
424
            progressStep = remainingProgress / size;
425

426
            // const res = new Result(undefined, this);
427

428
429
430
431
432
433
434
435
436
437
            // (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)
438
439
440
            while (variated[longest].values.hasNext) {
                // get next value for all variating parameters
                for (const v of variated) {
441
442
                    const currentIteratorValue = v.values.next();
                    v.param.v = currentIteratorValue.value;
443
                }
444
445
                // prepare a new slot to store results
                this.initNewResultElement();
446
                // calculate
447
448
                this.doCalc(computedSymbol, rInit); // résultat dans this.currentResult (resultElement le plus récent)
                if (this._result.resultElement.ok) {
449
                    rInit = this._result.resultElement.vCalc;
450
                }
451
452
                // update progress
                this.progress += progressStep;
453
            }
454
            // this._result = res;
455
456
            // round progress to 100%
            this.progress = 100;
457
458
        }

459
460
        if (computedSymbol !== undefined) {
            const realSymbol = (typeof computedSymbol === "string") ? computedSymbol : computedSymbol.symbol;
461
            this._result.symbol = realSymbol;
462
        }
463

464
465
        this.notifyResultUpdated();

466
        return this._result;
467
468
    }

Mathias Chouet's avatar
Mathias Chouet committed
469
470
471
472
473
474
475
476
477
478
    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
479
480
        // postprocessing
        this.adjustChildParameters(child);
Mathias Chouet's avatar
Mathias Chouet committed
481
    }
482
483

    public getChildren(): Nub[] {
Mathias Chouet's avatar
Mathias Chouet committed
484
        return this._children;
485
486
487
    }

    public getParent(): Nub {
Mathias Chouet's avatar
Mathias Chouet committed
488
        return this.parent;
489
490
    }

491
492
493
494
495
496
497
498
499
500
501
502
    /**
     * 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;
    }

503
504
505
506
507
    /**
     * 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[] {
508
        let res: LinkedValue[] = [];
509
510
        const symbol = src.symbol;

511
512
513
514
        // 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)) {
515

Mathias Chouet's avatar
Mathias Chouet committed
516
            // 1. own parameters
517
518
519
520
521
522
            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))
                ) {
523
524
                    // if it is safe to link p's value to src
                    if (p.isLinkableTo(src)) {
Mathias Chouet's avatar
Mathias Chouet committed
525
                        // if p is a CALC param of a Structure other than "Q"
526
                        // (structures always have Q as CALC param and cannot have another)
Mathias Chouet's avatar
Mathias Chouet committed
527
528
                        // 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
529
                        // expose its parent
530
                        if (
Mathias Chouet's avatar
Mathias Chouet committed
531
                            (
Mathias Chouet's avatar
Mathias Chouet committed
532
                              (this instanceof Structure && p.symbol !== "Q" && ! this.isSiblingOf(src.nubUid))
Mathias Chouet's avatar
Mathias Chouet committed
533
534
                              || this instanceof acSection
                            )
535
536
                            && (p.valueMode === ParamValueMode.CALCUL)
                        ) {
Mathias Chouet's avatar
Mathias Chouet committed
537
                            // trick to expose p as a result of the parent Nub
538
539
                            res.push(new LinkedValue(this.parent, p, p.symbol));
                        } else {
540
541
542
543
                            // do not suggest parameters that are already linked to another one
                            if (p.valueMode !== ParamValueMode.LINK) {
                                res.push(new LinkedValue(this, p, p.symbol));
                            }
544
                        }
545
546
547
                    }
                }
            }
548

549
            // 2. extra results
550
            if (this._resultsFamilies) {
551
                // if I don't depend on your result, you may depend on mine !
Mathias Chouet's avatar
Mathias Chouet committed
552
                if (! this.dependsOnNubResult(src.parentNub)) {
553
                    const erk = Object.keys(this._resultsFamilies);
554
                    // browse extra results
555
                    for (const erSymbol of erk) {
556
                        const erFamily = this._resultsFamilies[erSymbol];
557
558
559
560
561
562
                        // if family is identical
                        if (erFamily === src.family) {
                            res.push(new LinkedValue(this, undefined, erSymbol));
                        }
                    }
                }
563
564
            }
        }
565

566
567
568
569
570
        // 3. children Nubs, except for PAB
        if (! (this instanceof Pab)) {
            for (const cn of this.getChildren()) {
                res = res.concat(cn.getLinkableValues(src));
            }
571
572
        }

573
        return res;
574
    }
575

576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
    /**
     * 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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
    /**
     * 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
619
620
621
622
623
624
    /**
     * 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
625
        const requiredNubs: Nub[] = [];
Mathias Chouet's avatar
Mathias Chouet committed
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
        // 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;
    }

645
    /**
646
     * Returns all Nubs whose parameters or results are targetted
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
     * 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;
    }

666
    /**
667
668
669
670
671
672
673
674
675
676
     * 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
677
678
     *
     * If followLinksChain is false, will limit the exploration to the first target level only
679
     */
Mathias Chouet's avatar
Mathias Chouet committed
680
    public dependsOnNubResult(nub: Nub, followLinksChain: boolean = true): boolean {
681
682
683
684
685
686
687
        let thisFamily: Nub[] = [this];
        const tp = this.getParent();
        if (tp) {
            thisFamily = thisFamily.concat(tp);
        }
        thisFamily = thisFamily.concat(this.getChildren());

688
        let yourFamily: Nub[] = [];
Mathias Chouet's avatar
Mathias Chouet committed
689
        const you = nub;
690
691
692
693
694
695
696
        if (you) {
            yourFamily = [you];
            const yp = you.getParent();
            if (yp) {
                yourFamily = yourFamily.concat(yp);
            }
            yourFamily = yourFamily.concat(you.getChildren());
697
698
699
700
701
702
703
704
705
        }

        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
706
                    if (p.isLinkedToResultOfNubs(yourFamily, followLinksChain)) {
707
708
709
710
711
712
713
714
715
716
717
                        // dependence found !
                        depends = true;
                        break outerloop;
                    }
                }
            }
        }

        return depends;
    }

718
719
720
721
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
    /**
     * 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;
    }

757
758
759
760
    /**
     * 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
761
     * @param uid
762
763
764
765
     * @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
766
     */
767
768
769
770
771
772
    public resultDependsOnNub(
        uid: string,
        visited: string[] = [],
        symbol?: string,
        includeValuesLinks: boolean = false
    ): boolean {
773
774
775
776
777
778
        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) {
779
                    if (p.dependsOnNubFamily(uid, symbol, includeValuesLinks)) {
780
781
782
783
784
785
786
                        return true;
                    }
                }
            }
            // does any of our parent's parameters depend on the target Nub ?
            const parent = this.getParent();
            if (parent) {
787
                if (parent.resultDependsOnNub(uid, visited, symbol, includeValuesLinks)) {
788
789
790
791
792
                    return true;
                }
            }
            // does any of our children' parameters depend on the target Nub ?
            for (const c of this.getChildren()) {
793
                if (c.resultDependsOnNub(uid, visited, symbol, includeValuesLinks)) {
794
                    return true;
795
                }
796
            }
797
        }
798
799
        return false;
    }
800

801
802
803
804
805
806
    /**
     * 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 {
807
        let hmv = false;
Mathias Chouet's avatar
Mathias Chouet committed
808
        for (const p of this.parameterIterator) {
809
            if (p.valueMode === ParamValueMode.MINMAX || p.valueMode === ParamValueMode.LISTE) {
810
                hmv = true;
Mathias Chouet's avatar
Mathias Chouet committed
811
            } else if (p.valueMode === ParamValueMode.LINK && p.isReferenceDefined()) {
812
                // indirect recursivity
813
                hmv = hmv || p.referencedValue.hasMultipleValues();
814
            }
815
        }
816
        return hmv;
817
    }
818

819
820
    /**
     * Sets the current result to undefined, as well as the results
Mathias Chouet's avatar
Mathias Chouet committed
821
822
     * of all depending Nubs; also invalidates all fake ParamValues
     * held by LinkedValues pointing to this result
823
     */
824
    public resetResult(visited: string[] = []) {
825
        this._result = undefined;
826
        visited.push(this.uid);
827
828
        const dependingNubs = Session.getInstance().getDependingNubs(this.uid);
        for (const dn of dependingNubs) {
829
830
831
            if (! visited.includes(dn.uid)) {
                dn.resetResult(visited);
            }
Mathias Chouet's avatar
Mathias Chouet committed
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
            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();
                }
            }
850
851
852
        }
    }

853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
    /**
     * Returns a JSON representation of the Nub's current state
     * @param extra extra key-value pairs, for ex. calculator title in GUI
     */
    public serialise(extra?: object) {
        return JSON.stringify(this.objectRepresentation(extra));
    }

    /**
     * Returns an object representation of the Nub's current state
     * @param extra extra key-value pairs, for ex. calculator title in GUI
     */
    public objectRepresentation(extra?: object) {
        let ret: any = {
            uid: this.uid,
868
            props: Session.invertEnumKeysAndValuesInProperties(this.properties.props),
869
        };
Mathias Chouet's avatar
Mathias Chouet committed
870

871
872
873
        if (extra) {
            ret =  {...ret, ...{ meta: extra } }; // merge properties
        }
Mathias Chouet's avatar
Mathias Chouet committed
874
        ret = {...ret, ...{  children: [], parameters: [] } }; // extend here to make "parameters" the down-most key
875

Mathias Chouet's avatar
Mathias Chouet committed
876
877
878
        // iterate over local parameters
        const localParametersIterator =  new ParamsEquationArrayIterator([this._prms]);
        for (const p of localParametersIterator) {
879
880
            if (p.visible) {
                ret.parameters.push(p.objectRepresentation());
881
882
883
            }
        }

Mathias Chouet's avatar
Mathias Chouet committed
884
885
886
887
888
        // iterate over children Nubs
        for (const child of this._children) {
            ret.children.push(child.objectRepresentation());
        }

889
890
891
        return ret;
    }

892
893
894
    /**
     * 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
895
896
     * @returns the calculated parameter found, if any - used by child Nub to notify
     *          its parent of the calculated parameter to set
897
     */
898
899
900
901
902
903
    public loadObjectRepresentation(obj: any): { p: ParamDefinition, hasErrors: boolean } {
        // return value
        const ret: { p: ParamDefinition, hasErrors: boolean } = {
            p: undefined,
            hasErrors: false
        };
904
905
906
907
        // set parameter modes and values
        if (obj.parameters && Array.isArray(obj.parameters)) {
            for (const p of obj.parameters) {
                const param = this.getParameter(p.symbol);
908
909
910
911
912
913
914
915
916
917
918
                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 {
919
                    // tslint:disable-next-line:no-console
920
921
                    console.error(`session file : cannot find parameter ${p.symbol} in target Nub`);
                    ret.hasErrors = true;
922
923
                }
            }
Mathias Chouet's avatar
Mathias Chouet committed
924
            // define calculated param at Nub level
925
            // @TODO except if we are a Section / Structure / Cloisons ?
926
927
            if (ret.p) {
                this.calculatedParam = ret.p;
Mathias Chouet's avatar
Mathias Chouet committed
928
            }
929
        }
Mathias Chouet's avatar
Mathias Chouet committed
930
931
932
933

        // iterate over children if any
        if (obj.children && Array.isArray(obj.children)) {
            for (const s of obj.children) {
934
935
                // decode properties
                const props = Session.invertEnumKeysAndValuesInProperties(s.props, true);
Mathias Chouet's avatar
Mathias Chouet committed
936
                // create the Nub
937
                const subNub = Session.getInstance().createNub(new Props(props), this);
Mathias Chouet's avatar
Mathias Chouet committed
938
939
940
941
                // try to keep the original ID
                if (! Session.getInstance().uidAlreadyUsed(s.uid)) {
                    subNub.setUid(s.uid);
                }
942
                const childRet = subNub.loadObjectRepresentation(s);
Mathias Chouet's avatar
Mathias Chouet committed
943
                // add Structure to parent
944
                this.addChild(subNub);
Mathias Chouet's avatar
Mathias Chouet committed
945
                // set calculated parameter for child ?
946
947
948
949
950
951
                if (childRet.p) {
                    this.calculatedParam = childRet.p;
                }
                // forward errors
                if (childRet.hasErrors) {
                    ret.hasErrors = true;
Mathias Chouet's avatar
Mathias Chouet committed
952
953
954
955
                }
            }
        }

956
        return ret;
957
958
    }

959
960
961
962
    /**
     * Once session is loaded, run a second pass on all linked parameters to
     * reset their target if needed
     */
963
964
965
966
967
    public fixLinks(obj: any): { hasErrors: boolean } {
        // return value
        const ret = {
            hasErrors: false
        };
968
969
970
971
972
973
974
975
        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
976
977
978
                        try {
                            param.defineReference(destNub, p.targetParam);
                        } catch (err) {
979
                            // tslint:disable-next-line:no-console
Mathias Chouet's avatar
Fix #95    
Mathias Chouet committed
980
981
                            console.error(`fixLinks: defineReference error`
                                + ` (${this.uid}.${param.symbol} => ${destNub.uid}.${p.targetParam})`);
982
983
                            // forward error
                            ret.hasErrors = true;
Mathias Chouet's avatar
Fix #89    
Mathias Chouet committed
984
                        }
985
                    } else {
986
                        // tslint:disable-next-line:no-console
987
                        console.error("fixLinks : cannot find target Nub");
988
989
                        // forward error
                        ret.hasErrors = true;
990
991
992
993
                    }
                }
            }
        }
994
        return ret;
995
996
    }

Mathias Chouet's avatar
Mathias Chouet committed
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
    /**
     * 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})`);
        }
1033
1034
1035
        // postprocessing
        this.adjustChildParameters(child);
        // ensure one parameter is calculated
Mathias Chouet's avatar
Mathias Chouet committed
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
        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);
1059
    }
Mathias Chouet's avatar
Mathias Chouet committed
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092

    /**
     * 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;
            }
        }
1093
1094
1095
        return false;
    }

1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
    /**
     * @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
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
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
    /**
     * 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}`);
        }
    }

    /**
     * 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`);
    }

1163
    /**
1164
     * Adds a new empty ResultElement to the current Result object, so that
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
     * 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();
        }
    }

1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    /**
     * 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();
        }
    }

1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
    // 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: any, sender?: any) {
        this._observable.notifyObservers(data, sender);
    }

1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
    /**
     * Retrieves the ParamFamily associated to the given symbol, whether it is a
     * parameter or a result
     */
    public getFamily(symbol: string): ParamFamily {
        // is it a parameter ?
        const p = this.getParameter(symbol);
        if (p) {
            return p.family;
        }
        // is it a result ?
        if (symbol in this.extraResultsFamilies) {
            return this.extraResultsFamilies[symbol];
        }
        // give up
        return undefined;
    }

1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
    protected findCalculatedParameter(sDonnee: any): any {
        let computedSymbol: any;
        if (sDonnee) {
            computedSymbol = sDonnee;
        } else {
            if (this.calculatedParam === undefined) {
                throw new Error(`CalcSerie() : aucun paramètre à calculer`);
            }
            computedSymbol = this.calculatedParamDescriptor;
        }
        return computedSymbol;
    }

1245
1246
1247
1248
    protected doCalc(computedSymbol?: any, rInit?: number) {
        return this.Calc(computedSymbol, rInit);
    }

Mathias Chouet's avatar
lint    
Mathias Chouet committed
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
    /**
     * Returns values of parameters and the result of the calculation for the calculated parameter
     * @param sVarCalc Symbol of the calculated param
     * @param result Result object of the calculation
     */
    protected getParamValuesAfterCalc(sVarCalc: string, result: Result): { [key: string]: number } {
        const cPrms: { [key: string]: number } = {};
        for (const p of this.parameterIterator) {
            if (p.symbol === sVarCalc) {
                cPrms[p.symbol] = result.vCalc;
            } else {
                cPrms[p.symbol] = p.v;
            }
        }
        return cPrms;
    }

1266
1267
    /**
     * For all SINGLE, LINK and CALC parameters, copies singleValue to
1268
     * sandbox value (.v) before calculation
1269
     */
1270
    protected copySingleValuesToSandboxValues() {
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
        for (const p of this.parameterIterator) {
            switch (p.valueMode) {
                case ParamValueMode.SINGLE:
                case ParamValueMode.CALCUL:
                    p.v = p.singleValue;
                    break;
                case ParamValueMode.LINK:
                    if (p.referencedValue) {
                        p.v = p.referencedValue.getValue();
                    } else {
                        throw Error(