|
692 | 692 | detailedDescription: "Construct the experimental model for use in ExprProc simulator\ |
693 | 693 | \ from parameters. Cvr and Mvr/Dvr needs to be\r\n contained in same SmpcAppl/MPCAppl/NMPCAppl.\r\ |
694 | 694 | \n The Laplace transform model is y/u = (1 + lead1*s)*exp(-delay*s)/(1 + lag1*s)(1\ |
695 | | - \ + lag2*s) where lead1, delay, lag1 and\r\n lag2 are given in minutes." |
| 695 | + \ + lag2*s) where lead1, delay, lag1\r\n and lag2 are given in minutes." |
696 | 696 | quality: GOOD if valid model between cvr and xvr, and all inputs are GOOD, else |
697 | 697 | BAD |
698 | 698 | - name: exprprocmodset |
|
724 | 724 | - value |
725 | 725 | arity: '1' |
726 | 726 | retr: "steady state gain, of the scaled Amodl if CV and IV belongs to same SmpcAppl/MPCAppl/NMPCAppl\ |
727 | | - \ with an ExprModl\r\n and Amodl exists, else 0" |
| 727 | + \ with an\r\n ExprModl and Amodl exists, else 0" |
728 | 728 | detailedDescription: Set the gain modifier in the active experimental model (ExprIvr.Scale) |
729 | 729 | of ExprProc |
730 | 730 | quality: GOOD if CV and IV belongs to same SmpcAppl/MPCAppl/NMPCAppl with an ExprModl |
|
1580 | 1580 | retr: Calculated quality of mix, 0 if sum of volumes = 0 |
1581 | 1581 | detailedDescription: Calculate flash of a mix |
1582 | 1582 | quality: GOOD if all supplied parameters are GOOD |
| 1583 | +- name: idiv |
| 1584 | + signature: idiv(a, b) |
| 1585 | + parameters: |
| 1586 | + - name: a |
| 1587 | + description: Dividend |
| 1588 | + direction: in |
| 1589 | + datatype: |
| 1590 | + - value |
| 1591 | + arity: '1' |
| 1592 | + - name: b |
| 1593 | + description: Divisor (must be non-zero) |
| 1594 | + direction: in |
| 1595 | + datatype: |
| 1596 | + - value |
| 1597 | + arity: '1' |
| 1598 | + retr: Integer quotient trunc(a) / trunc(b) |
| 1599 | + detailedDescription: "Computes the integer quotient of a divided by b, following\ |
| 1600 | + \ the C++\r\n built-in integer division semantics (truncation toward zero), as\ |
| 1601 | + \ described in\r\n https://en.cppreference.com/w/cpp/language/operator_arithmetic.html\ |
| 1602 | + \ and\r\n https://en.cppreference.com/w/cpp/numeric/math/div.html. The inputs\ |
| 1603 | + \ are\r\n first truncated toward zero to int, and the integer quotient is\r\n\ |
| 1604 | + \ returned as a double." |
| 1605 | + quality: GOOD only if both a and b are GOOD and b != 0 |
1583 | 1606 | - name: if |
1584 | 1607 | signature: if(condition, trueexpr, falseexpr, notinuse) |
1585 | 1608 | parameters: |
|
1639 | 1662 | quality: "GOOD if number of arguments is odd and >= 3 and all cond's and selected\ |
1640 | 1663 | \ expressions up to and including the\r\n last (returned) evaluated expression\ |
1641 | 1664 | \ are GOOD, else BAD." |
| 1665 | +- name: imod |
| 1666 | + signature: imod(a, b) |
| 1667 | + parameters: |
| 1668 | + - name: a |
| 1669 | + description: Dividend |
| 1670 | + direction: in |
| 1671 | + datatype: |
| 1672 | + - value |
| 1673 | + arity: '1' |
| 1674 | + - name: b |
| 1675 | + description: Divisor (must be non-zero) |
| 1676 | + direction: in |
| 1677 | + datatype: |
| 1678 | + - value |
| 1679 | + arity: '1' |
| 1680 | + retr: Integer remainder trunc(a) % trunc(b) |
| 1681 | + detailedDescription: "Computes the integer remainder of a divided by b, following\ |
| 1682 | + \ the C++\r\n built-in integer remainder semantics (sign of result follows the\ |
| 1683 | + \ dividend),\r\n as described in\r\n https://en.cppreference.com/w/cpp/language/operator_arithmetic.html\ |
| 1684 | + \ and\r\n https://en.cppreference.com/w/cpp/numeric/math/div.html. The inputs\ |
| 1685 | + \ are\r\n first truncated toward zero to int, then a % b is returned as a\r\n\ |
| 1686 | + \ double. The identity (a/b)*b + a%b == a holds." |
| 1687 | + quality: GOOD only if both a and b are GOOD and b != 0 |
1642 | 1688 | - name: intpoltype1 |
1643 | 1689 | signature: intpoltype1(x, X1, Y1, X2, Y2, ..., XN, YN) |
1644 | 1690 | parameters: |
|
2106 | 2152 | retr: Steady state gain from xvr towards cvr if valid model, else 0 |
2107 | 2153 | detailedDescription: "Get the steady state gain from the active experimental model,\ |
2108 | 2154 | \ including the scaling by\r\n the gain modifier (Scale) set by CalcModSet. Cvr\ |
2109 | | - \ and Mvr/Dvr needs to be contained in same SmpcAppl/MPCAppl/NMPCAppl." |
| 2155 | + \ and Mvr/Dvr needs to be contained in same\r\n SmpcAppl/MPCAppl/NMPCAppl." |
2110 | 2156 | quality: GOOD if valid model between cvr and xvr |
2111 | 2157 | - name: modsched |
2112 | 2158 | signature: modsched(cvr, xvr, gain, lag1, lag2, lead1, delay, apply) |
|
2786 | 2832 | retr: Set value |
2787 | 2833 | detailedDescription: Set deas for dvr |
2788 | 2834 | quality: state if valid dvr otherwise BAD |
| 2835 | +- name: setdvdeltapred |
| 2836 | + signature: setdvdeltapred(dvr, N, X1, Y1, X2, Y2, ..., XN, YN) |
| 2837 | + parameters: |
| 2838 | + - name: dvr |
| 2839 | + description: Dvr Tag |
| 2840 | + direction: in |
| 2841 | + datatype: |
| 2842 | + - value |
| 2843 | + arity: '1' |
| 2844 | + - name: N |
| 2845 | + description: Number of deltas (>= 0) |
| 2846 | + direction: in |
| 2847 | + datatype: |
| 2848 | + - value |
| 2849 | + arity: '1' |
| 2850 | + - name: Xn |
| 2851 | + description: X - values (sample number). Assumed to be monotonically increasing |
| 2852 | + direction: in |
| 2853 | + datatype: |
| 2854 | + - value |
| 2855 | + arity: N |
| 2856 | + - name: Yn |
| 2857 | + description: Y - values corresponding to X - values |
| 2858 | + direction: in |
| 2859 | + datatype: |
| 2860 | + - value |
| 2861 | + arity: N |
| 2862 | + retr: Resulting sum of deltas Yn |
| 2863 | + detailedDescription: "Sets the DeltaPred member of a Dvr object. X1 is the number\ |
| 2864 | + \ of samples until the first change (delta) in\r\n DV in the prediction and Y1\ |
| 2865 | + \ is the corresponding delta. Assumes that the sequence of X1, X2, ..., XN values\ |
| 2866 | + \ are\r\n monotonically increasing" |
| 2867 | + quality: GOOD only if ALL arguments are GOOD and valid dvr and else BAD |
| 2868 | +- name: setdvdeltapredfromcv |
| 2869 | + signature: setdvdeltapredfromcv(dvr, cvr[, scale]) |
| 2870 | + parameters: |
| 2871 | + - name: dvr |
| 2872 | + description: Dvr Tag |
| 2873 | + direction: in |
| 2874 | + datatype: |
| 2875 | + - value |
| 2876 | + arity: '1' |
| 2877 | + - name: cvr |
| 2878 | + description: Cvr Tag whose predictions are copied as step deltas |
| 2879 | + direction: in |
| 2880 | + datatype: |
| 2881 | + - value |
| 2882 | + arity: '1' |
| 2883 | + - name: scale |
| 2884 | + description: "Optional scaling factor applied to each step delta before storing\ |
| 2885 | + \ in the\r\n DV. Defaults to 1.0 when omitted." |
| 2886 | + direction: in |
| 2887 | + datatype: |
| 2888 | + - value |
| 2889 | + arity: '1' |
| 2890 | + retr: Sum of the copied (scaled) deltas |
| 2891 | + detailedDescription: "Copies the Cvr predictions into the DeltaPred member of a\ |
| 2892 | + \ Dvr as steps at the\r\n Cvr's evaluation points, optionally scaled by the given\ |
| 2893 | + \ factor. For each evaluation point\r\n EvalPnt[i] of the Cvr, the delta written\ |
| 2894 | + \ into the Dvr is the change in the Cvr prediction\r\n between consecutive evaluation\ |
| 2895 | + \ points (the first eval point is referenced against the\r\n current Cvr measurement),\ |
| 2896 | + \ multiplied by scale." |
| 2897 | + quality: GOOD if all arguments resolve correctly, otherwise BAD |
| 2898 | +- name: setdvdeltapredfrommv |
| 2899 | + signature: setdvdeltapredfrommv(dvr, mvr[, scale]) |
| 2900 | + parameters: |
| 2901 | + - name: dvr |
| 2902 | + description: Dvr Tag |
| 2903 | + direction: in |
| 2904 | + datatype: |
| 2905 | + - value |
| 2906 | + arity: '1' |
| 2907 | + - name: mvr |
| 2908 | + description: Mvr Tag whose predicted deltas are copied |
| 2909 | + direction: in |
| 2910 | + datatype: |
| 2911 | + - value |
| 2912 | + arity: '1' |
| 2913 | + - name: scale |
| 2914 | + description: "Optional scaling factor applied to each MV delta before storing\ |
| 2915 | + \ in the\r\n DV. Defaults to 1.0 when omitted." |
| 2916 | + direction: in |
| 2917 | + datatype: |
| 2918 | + - value |
| 2919 | + arity: '1' |
| 2920 | + retr: Sum of the copied (scaled) deltas |
| 2921 | + detailedDescription: "Copies the predicted future moves of an Mvr into the DeltaPred\ |
| 2922 | + \ member of a Dvr,\r\n optionally scaled by the given factor. For each prediction\ |
| 2923 | + \ step i in 1..Npred, sets\r\n dvr->setDeltaPred(i, scale * mvr->mgetdv(N + i))." |
| 2924 | + quality: GOOD if all arguments resolve correctly, otherwise BAD |
2789 | 2925 | - name: setfulf |
2790 | 2926 | signature: setfulf(xvr, value) |
2791 | 2927 | parameters: |
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments