@@ -24,31 +24,34 @@ import kotlin.reflect.typeOf
24
24
/* *
25
25
* ## The CumSum Operation
26
26
*
27
- * Computes the cumulative sum of the values in the {@get DATA_TYPE}.
27
+ * Computes the cumulative sums of the values in the each column from the {@get [CumSumDocs.DATA_TYPE]}
28
+ * from the first row to the last row.
28
29
*
29
30
* __NOTE:__ If the column contains nullable values and `skipNA` is set to `true`,
30
- * skips null values when computing the cumulative sum.
31
+ * null values are skipped when computing the cumulative sum.
31
32
* Otherwise, any null value encountered will propagate null values in the output from that point onward.
32
33
*
33
- * {@get [CUMSUM_PARAM] @param [columns]
34
+ * {@get [CumSumDocs. CUMSUM_PARAM] @param [columns\ ]
34
35
* The names of the columns to apply cumSum operation.}
35
36
*
36
- * @param [skipNA] Whether to skip null values (default: `true`).
37
+ * @param [skipNA\ ] Whether to skip null values (default: `true`).
37
38
*
38
- * @return A new {@get DATA_TYPE} of the same type with the cumulative sum of the values .
39
+ * @return A new {@get [CumSumDocs. DATA_TYPE] } of the same type with the cumulative sums .
39
40
*
40
- * {@get [CUMSUM_PARAM] @see [Selecting Columns][SelectSelectingOptions].}
41
+ * {@get [CumSumDocs. CUMSUM_PARAM] @see [Selecting Columns][SelectSelectingOptions].}
41
42
* @see {@include [DocumentationUrls.CumSum]}
42
43
*/
43
44
@ExcludeFromSources
44
45
@Suppress(" ClassName" )
45
46
private interface CumSumDocs {
46
47
interface CUMSUM_PARAM
48
+
49
+ interface DATA_TYPE
47
50
}
48
51
49
52
/* *
50
53
* {@include [CumSumDocs]}
51
- * {@set DATA_TYPE [DataColumn]}.
54
+ * {@set [CumSumDocs. DATA_TYPE] [DataColumn]}
52
55
* {@set [CumSumDocs.CUMSUM_PARAM]}
53
56
*/
54
57
public fun <T : Number ?> DataColumn<T>.cumSum (skipNA : Boolean = defaultCumSumSkipNA): DataColumn <T > =
@@ -114,7 +117,7 @@ private val supportedClasses = setOf(
114
117
115
118
/* *
116
119
* {@include [CumSumDocs]}
117
- * {@set DATA_TYPE [DataFrame]}.
120
+ * {@set [CumSumDocs. DATA_TYPE] [DataFrame]}
118
121
*/
119
122
public fun <T , C > DataFrame<T>.cumSum (
120
123
skipNA : Boolean = defaultCumSumSkipNA,
@@ -124,14 +127,14 @@ public fun <T, C> DataFrame<T>.cumSum(
124
127
125
128
/* *
126
129
* {@include [CumSumDocs]}
127
- * {@set DATA_TYPE [DataFrame]}.
130
+ * {@set [CumSumDocs. DATA_TYPE] [DataFrame]}
128
131
*/
129
132
public fun <T > DataFrame<T>.cumSum (vararg columns : String , skipNA : Boolean = defaultCumSumSkipNA): DataFrame <T > =
130
133
cumSum(skipNA) { columns.toColumnSet() }
131
134
132
135
/* *
133
136
* {@include [CumSumDocs]}
134
- * {@set DATA_TYPE [DataFrame]}.
137
+ * {@set [CumSumDocs. DATA_TYPE] [DataFrame]}
135
138
*/
136
139
@AccessApiOverload
137
140
public fun <T > DataFrame<T>.cumSum (
@@ -141,15 +144,15 @@ public fun <T> DataFrame<T>.cumSum(
141
144
142
145
/* *
143
146
* {@include [CumSumDocs]}
144
- * {@set DATA_TYPE [DataFrame]}.
147
+ * {@set [CumSumDocs. DATA_TYPE] [DataFrame]}
145
148
*/
146
149
@AccessApiOverload
147
150
public fun <T > DataFrame<T>.cumSum (vararg columns : KProperty <* >, skipNA : Boolean = defaultCumSumSkipNA): DataFrame <T > =
148
151
cumSum(skipNA) { columns.toColumnSet() }
149
152
150
153
/* *
151
154
* {@include [CumSumDocs]}
152
- * {@set DATA_TYPE [DataFrame]}.
155
+ * {@set [CumSumDocs. DATA_TYPE] [DataFrame]}
153
156
* {@set [CumSumDocs.CUMSUM_PARAM]}
154
157
*/
155
158
public fun <T > DataFrame<T>.cumSum (skipNA : Boolean = defaultCumSumSkipNA): DataFrame <T > =
@@ -163,7 +166,7 @@ public fun <T> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataF
163
166
164
167
/* *
165
168
* {@include [CumSumDocs]}
166
- * {@set DATA_TYPE [GroupBy]}.
169
+ * {@set [CumSumDocs. DATA_TYPE] [GroupBy]}
167
170
*/
168
171
public fun <T , G , C > GroupBy <T , G >.cumSum (
169
172
skipNA : Boolean = defaultCumSumSkipNA,
@@ -172,14 +175,14 @@ public fun <T, G, C> GroupBy<T, G>.cumSum(
172
175
173
176
/* *
174
177
* {@include [CumSumDocs]}
175
- * {@set DATA_TYPE [GroupBy]}.
178
+ * {@set [CumSumDocs. DATA_TYPE] [GroupBy]}
176
179
*/
177
180
public fun <T , G > GroupBy <T , G >.cumSum (vararg columns : String , skipNA : Boolean = defaultCumSumSkipNA): GroupBy <T , G > =
178
181
cumSum(skipNA) { columns.toColumnSet() }
179
182
180
183
/* *
181
184
* {@include [CumSumDocs]}
182
- * {@set DATA_TYPE [GroupBy]}.
185
+ * {@set [CumSumDocs. DATA_TYPE] [GroupBy]}
183
186
*/
184
187
@AccessApiOverload
185
188
public fun <T , G > GroupBy <T , G >.cumSum (
@@ -189,7 +192,7 @@ public fun <T, G> GroupBy<T, G>.cumSum(
189
192
190
193
/* *
191
194
* {@include [CumSumDocs]}
192
- * {@set DATA_TYPE [GroupBy]}.
195
+ * {@set [CumSumDocs. DATA_TYPE] [GroupBy]}
193
196
*/
194
197
@AccessApiOverload
195
198
public fun <T , G > GroupBy <T , G >.cumSum (
@@ -199,7 +202,7 @@ public fun <T, G> GroupBy<T, G>.cumSum(
199
202
200
203
/* *
201
204
* {@include [CumSumDocs]}
202
- * {@set DATA_TYPE [GroupBy]}.
205
+ * {@set [CumSumDocs. DATA_TYPE] [GroupBy]}
203
206
* {@set [CumSumDocs.CUMSUM_PARAM]}
204
207
*/
205
208
public fun <T , G > GroupBy <T , G >.cumSum (skipNA : Boolean = defaultCumSumSkipNA): GroupBy <T , G > =
0 commit comments