Commit b41330b5 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

timcumsum: added docu.

parent 425be745
...@@ -231,6 +231,7 @@ Operator catalog: ...@@ -231,6 +231,7 @@ Operator catalog:
------------------------------------------------------------- -------------------------------------------------------------
Statistical values Statistical values
------------------------------------------------------------- -------------------------------------------------------------
Timcumsum timcumsum Cumulative sum over all timesteps
Consecstat consecsum Consecutive Sum Consecstat consecsum Consecutive Sum
Consecstat consects Consecutive Timesteps Consecstat consects Consecutive Timesteps
Ensstat ensmin Ensemble minimum Ensstat ensmin Ensemble minimum
......
...@@ -48,6 +48,7 @@ Ydayarith Arithmetic ...@@ -48,6 +48,7 @@ Ydayarith Arithmetic
Ymonarith Arithmetic Ymonarith Arithmetic
Yseasarith Arithmetic Yseasarith Arithmetic
Arithdays Arithmetic Arithdays Arithmetic
Timcumsum Statistical values
Consecstat Statistical values Consecstat Statistical values
Ensstat Statistical values Ensstat Statistical values
Ensstat2 Statistical values Ensstat2 Statistical values
......
@BeginModule @BeginModule
@NewPage
@Name = Consecstat @Name = Consecstat
@Title = Consecute timestep periods @Title = Consecute timestep periods
@Section = Statistical values @Section = Statistical values
......
BeginModule @BeginModule
@NewPage @NewPage
@Name = Timcumsum @Name = Timcumsum
@Title = Cumulative sum over all timesteps @Title = Cumulative sum over all timesteps
...@@ -19,9 +19,11 @@ Missing values are treated as numeric zero when summing. ...@@ -19,9 +19,11 @@ Missing values are treated as numeric zero when summing.
@BeginDescription @BeginDescription
@IfMan @IfMan
o(t,x) = sum{i(t',x), 0<t'<=t} o(t,x) = sum{i(t',x), 0<t'<=t}
@EndifMan @EndifMan
@IfDoc @IfDoc
\ \newline
@BeginMath @BeginMath
o(t,x) = \mbox{\textbf{sum}}\{i(t',x), 0 < t' \leq t\} o(t,x) = \mbox{\textbf{sum}}\{i(t',x), 0 < t' \leq t\}
@EndMath @EndMath
......
...@@ -734,7 +734,7 @@ static modules_t Modules[] = ...@@ -734,7 +734,7 @@ static modules_t Modules[] =
{ Timcount, NULL, MoncountOperators, 1, CDI_BOTH, 1, 1 }, { Timcount, NULL, MoncountOperators, 1, CDI_BOTH, 1, 1 },
{ Timcount, NULL, DaycountOperators, 1, CDI_BOTH, 1, 1 }, { Timcount, NULL, DaycountOperators, 1, CDI_BOTH, 1, 1 },
{ Timcount, NULL, HourcountOperators, 1, CDI_BOTH, 1, 1 }, { Timcount, NULL, HourcountOperators, 1, CDI_BOTH, 1, 1 },
{ Timcumsum, NULL, TimcumsumOperators, 1, CDI_BOTH, 1, 1 }, { Timcumsum, TimcumsumHelp, TimcumsumOperators, 1, CDI_BOTH, 1, 1 },
{ Timpctl, TimpctlHelp, TimpctlOperators, 1, CDI_REAL, 3, 1 }, { Timpctl, TimpctlHelp, TimpctlOperators, 1, CDI_REAL, 3, 1 },
{ Timpctl, YearpctlHelp, YearpctlOperators, 1, CDI_REAL, 3, 1 }, { Timpctl, YearpctlHelp, YearpctlOperators, 1, CDI_REAL, 3, 1 },
{ Timpctl, MonpctlHelp, MonpctlOperators, 1, CDI_REAL, 3, 1 }, { Timpctl, MonpctlHelp, MonpctlOperators, 1, CDI_REAL, 3, 1 },
......
...@@ -1708,6 +1708,21 @@ static const char *ArithdaysHelp[] = { ...@@ -1708,6 +1708,21 @@ static const char *ArithdaysHelp[] = {
NULL NULL
}; };
static const char *TimcumsumHelp[] = {
"NAME",
" timcumsum - Cumulative sum over all timesteps",
"",
"SYNOPSIS",
" timcumsum ifile ofile",
"",
"DESCRIPTION",
" The timcumsum operator calculates the cumulative sum over all timesteps.",
" Missing values are treated as numeric zero when summing.",
" ",
" o(t,x) = sum{i(t',x), 0<t'<=t}",
NULL
};
static const char *ConsecstatHelp[] = { static const char *ConsecstatHelp[] = {
"NAME", "NAME",
" consecsum, consects - Consecute timestep periods", " consecsum, consects - Consecute timestep periods",
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment