-
Notifications
You must be signed in to change notification settings - Fork 31
/
DataViewRow.xml
280 lines (277 loc) · 16.7 KB
/
DataViewRow.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
151
152
153
154
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<Type Name="DataViewRow" FullName="Microsoft.ML.DataViewRow">
<TypeSignature Language="C#" Value="public abstract class DataViewRow : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit DataViewRow extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.DataViewRow" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class DataViewRow
Implements IDisposable" />
<TypeSignature Language="F#" Value="type DataViewRow = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A logical row of data. May be a row of an <see cref="T:Microsoft.ML.IDataView" /> or a stand-alone row.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DataViewRow ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Batch">
<MemberSignature Language="C#" Value="public abstract long Batch { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Batch" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.DataViewRow.Batch" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Batch As Long" />
<MemberSignature Language="F#" Value="member this.Batch : int64" Usage="Microsoft.ML.DataViewRow.Batch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
This provides a means for reconciling multiple rows that have been produced generally from
<see cref="M:Microsoft.ML.IDataView.GetRowCursorSet(System.Collections.Generic.IEnumerable{Microsoft.ML.DataViewSchema.Column},System.Int32,System.Random)" />. When getting a set, there is a need
to, while allowing parallel processing to proceed, always have an aim that the original order should be
recoverable. Note, whether or not a user cares about that original order in one's specific application is
another story altogether (most callers of this as a practical matter do not, otherwise they would not call
it), but at least in principle it should be possible to reconstruct the original order one would get from an
identically configured <see cref="M:Microsoft.ML.IDataView.GetRowCursor(System.Collections.Generic.IEnumerable{Microsoft.ML.DataViewSchema.Column},System.Random)" />. So: for any cursor
implementation, batch numbers should be non-decreasing. Furthermore, any given batch number should only
appear in one of the cursors as returned by
<see cref="M:Microsoft.ML.IDataView.GetRowCursorSet(System.Collections.Generic.IEnumerable{Microsoft.ML.DataViewSchema.Column},System.Int32,System.Random)" />. In this way, order is determined by
batch number. An operation that reconciles these cursors to produce a consistent single cursoring, could do
so by drawing from the single cursor, among all cursors in the set, that has the smallest batch number
available.
Note that there is no suggestion that the batches for a particular entry will be consistent from cursoring
to cursoring, except for the consistency in resulting in the same overall ordering. The same entry could
have different batch numbers from one cursoring to another. There is also no requirement that any given
batch number must appear, at all. It is merely a mechanism for recovering ordering from a possibly arbitrary
partitioning of the data. It also follows from this, of course, that considering the batch to be a property
of the data is completely invalid.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="dataViewRow.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Implementation of dispose. Calls <see cref="M:Microsoft.ML.DataViewRow.Dispose(System.Boolean)" /> with <see langword="true" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="dataViewRow.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">Whether this was called from <see cref="M:System.IDisposable.Dispose" />.
Subclasses that implement <see cref="M:System.Object.Finalize" /> should call this method with
<see langword="false" />, but I hasten to add that implementing finalizers should be
avoided if at all possible.</param>
<summary>
The disposable method for the disposable pattern. This default implementation does nothing.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetGetter<TValue>">
<MemberSignature Language="C#" Value="public abstract Microsoft.ML.ValueGetter<TValue> GetGetter<TValue> (Microsoft.ML.DataViewSchema.Column column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ML.ValueGetter`1<!!TValue> GetGetter<TValue>(valuetype Microsoft.ML.DataViewSchema/Column column) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.GetGetter``1(Microsoft.ML.DataViewSchema.Column)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetGetter(Of TValue) (column As DataViewSchema.Column) As ValueGetter(Of TValue)" />
<MemberSignature Language="F#" Value="abstract member GetGetter : Microsoft.ML.DataViewSchema.Column -> Microsoft.ML.ValueGetter<'Value>" Usage="dataViewRow.GetGetter column" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.ValueGetter<TValue></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TValue" />
</TypeParameters>
<Parameters>
<Parameter Name="column" Type="Microsoft.ML.DataViewSchema+Column" />
</Parameters>
<Docs>
<typeparam name="TValue"> is the column's content type.</typeparam>
<param name="column"> is the output column whose getter should be returned.</param>
<summary>
Returns a value getter delegate to fetch the value of the given <paramref name="column" />, from the row.
This throws if the column is not active in this row, or if the type
<typeparamref name="TValue" /> differs from this column's type.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetIdGetter">
<MemberSignature Language="C#" Value="public abstract Microsoft.ML.ValueGetter<Microsoft.ML.Data.DataViewRowId> GetIdGetter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ML.ValueGetter`1<valuetype Microsoft.ML.Data.DataViewRowId> GetIdGetter() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.GetIdGetter" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetIdGetter () As ValueGetter(Of DataViewRowId)" />
<MemberSignature Language="F#" Value="abstract member GetIdGetter : unit -> Microsoft.ML.ValueGetter<Microsoft.ML.Data.DataViewRowId>" Usage="dataViewRow.GetIdGetter " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.ValueGetter<Microsoft.ML.Data.DataViewRowId></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
A getter for a 128-bit ID value. It is common for objects to serve multiple <see cref="T:Microsoft.ML.DataViewRow" />
instances to iterate over what is supposed to be the same data, for example, in a <see cref="T:Microsoft.ML.IDataView" />
a cursor set will produce the same data as a serial cursor, just partitioned, and a shuffled cursor will
produce the same data as a serial cursor or any other shuffled cursor, only shuffled. The ID exists for
applications that need to reconcile which entry is actually which. Ideally this ID should be unique, but for
practical reasons, it suffices if collisions are simply extremely improbable.
Note that this ID, while it must be consistent for multiple streams according to the semantics above, is not
considered part of the data per se. So, to take the example of a data view specifically, a single data view
must render consistent IDs across all cursorings, but there is no suggestion at all that if the "same" data
were presented in a different data view (as by, say, being transformed, cached, saved, or whatever), that
the IDs between the two different data views would have any discernible relationship.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsColumnActive">
<MemberSignature Language="C#" Value="public abstract bool IsColumnActive (Microsoft.ML.DataViewSchema.Column column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsColumnActive(valuetype Microsoft.ML.DataViewSchema/Column column) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.DataViewRow.IsColumnActive(Microsoft.ML.DataViewSchema.Column)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function IsColumnActive (column As DataViewSchema.Column) As Boolean" />
<MemberSignature Language="F#" Value="abstract member IsColumnActive : Microsoft.ML.DataViewSchema.Column -> bool" Usage="dataViewRow.IsColumnActive column" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="Microsoft.ML.DataViewSchema+Column" />
</Parameters>
<Docs>
<param name="column">To be added.</param>
<summary>
Returns whether the given column is active in this row.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public abstract long Position { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Position" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.DataViewRow.Position" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Position As Long" />
<MemberSignature Language="F#" Value="member this.Position : int64" Usage="Microsoft.ML.DataViewRow.Position" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
This is incremented when the underlying contents changes, giving clients a way to detect change. It should be
-1 when the object is in a state where values cannot be fetched. In particular, for an <see cref="T:Microsoft.ML.DataViewRowCursor" />,
this will be before <see cref="M:Microsoft.ML.DataViewRowCursor.MoveNext" /> if ever called for the first time, or after the first time
<see cref="M:Microsoft.ML.DataViewRowCursor.MoveNext" /> is called and returns <see langword="false" />.
Note that this position is not position within the underlying data, but position of this cursor only. If
one, for example, opened a set of parallel streaming cursors, or a shuffled cursor, each such cursor's first
valid entry would always have position 0.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public abstract Microsoft.ML.DataViewSchema Schema { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ML.DataViewSchema Schema" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.DataViewRow.Schema" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Schema As DataViewSchema" />
<MemberSignature Language="F#" Value="member this.Schema : Microsoft.ML.DataViewSchema" Usage="Microsoft.ML.DataViewRow.Schema" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.DataViewSchema</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.ML.DataViewRow.Schema" />, which provides name and type information for variables
(i.e., columns in ML.NET's type system) stored in this row.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>