GroupBy.xml

<Type Name="GroupBy" FullName="Microsoft.Data.Analysis.GroupBy">
  <TypeSignature Language="C#" Value="public abstract class GroupBy" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit GroupBy extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Data.Analysis.GroupBy" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class GroupBy" />
  <TypeSignature Language="F#" Value="type GroupBy = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            A GroupBy class that is typically the result of a DataFrame.GroupBy call.
            It holds information to perform typical aggregation ops on it.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected GroupBy ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Count">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Count (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Count(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Count(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Count (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Count : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Count columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">To be added.</param>
        <summary>
            Compute the number of non-null values in each group 
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="First">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame First (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame First(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.First(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function First (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member First : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.First columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">To be added.</param>
        <summary>
            Return the first value in each group
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Head">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Head (int numberOfRows);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Head(int32 numberOfRows) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Head(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Head (numberOfRows As Integer) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Head : int -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Head numberOfRows" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="numberOfRows" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="numberOfRows" />
        <summary>
            Returns the first <paramref name="numberOfRows" /> rows of each group
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Max">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Max (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Max(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Max(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Max (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Max : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Max columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">The columns to find the max of. A default value finds the max of all columns</param>
        <summary>
            Compute the max of group values
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Mean">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Mean (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Mean(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Mean(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Mean (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Mean : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Mean columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">The columns to find the mean of. A Default value finds the mean of all columns</param>
        <summary>
            Compute the mean of group values
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Min">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Min (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Min(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Min(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Min (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Min : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Min columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">The columns to find the min of. A default value finds the min of all columns</param>
        <summary>
            Compute the min of group values
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Product">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Product (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Product(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Product(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Product (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Product : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Product columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">The columns to find the product of. A default value finds the product of all columns</param>
        <summary>
            Compute the product of group values
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Sum">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Sum (params string[] columnNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Sum(string[] columnNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Sum(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Sum (ParamArray columnNames As String()) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Sum : string[] -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Sum columnNames" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="columnNames" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="columnNames">The columns to sum. A Default value sums up all columns</param>
        <summary>
            Compute the sum of group values
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Tail">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Data.Analysis.DataFrame Tail (int numberOfRows);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Data.Analysis.DataFrame Tail(int32 numberOfRows) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Data.Analysis.GroupBy.Tail(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Tail (numberOfRows As Integer) As DataFrame" />
      <MemberSignature Language="F#" Value="abstract member Tail : int -&gt; Microsoft.Data.Analysis.DataFrame" Usage="groupBy.Tail numberOfRows" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Data.Analysis</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Data.Analysis.DataFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="numberOfRows" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="numberOfRows" />
        <summary>
            Returns the last <paramref name="numberOfRows" /> rows of each group
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>