Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Nuget packages
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.DataAnalysis.Models
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Providers
    • Extreme.Providers.InteropServices
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Data
    • AutoCategorization Enumeration
    • CompositeDataStream(TObject) Class
    • DataExtensions Class
    • DataObjectConverter(TObject) Class
    • DataObjectKind Enumeration
    • DataStream Class
    • DataStream(TObject) Class
    • IDataObject(TObject) Interface
    • INamedDataFileObject(TObject) Interface
    • TextDataStream Class
    • TextOptions Class
    • TextOptionsExtensions Class
  • DataExtensions Class
    • Methods
  • Methods
    • ReadDataFrame Method Overloads
    • ToDataFrame Method Overloads
    • ToDataTable Method Overloads
  • ReadDataFrame Method Overloads
    • ReadDataFrame Method (IDataReader, Int32)
    • ReadDataFrame Method (IDataReader, IEnumerable(String), Int32)
    • ReadDataFrame(R) Method (IDataReader, String, Int32, Boolean)
    • ReadDataFrame(R) Method (IDataReader, String, IEnumerable(String), Int32, Boolean)
  • ReadDataFrame(R) Method (IDataReader, String, IEnumerable(String), Int32, Boolean)

DataExtensionsReadDataFrameR Method (IDataReader, String, IEnumerableString, Int32, Boolean)

Extreme Optimization Numerical Libraries for .NET Professional
Reads the specified columns from a data reader and returns them as a data frame using the specified column as row keys.

Namespace:  Extreme.Data
Assembly:  Extreme.Data (in Extreme.Data.dll) Version: 3.1.0
Syntax

C#
VB
C++
F#
Copy
public static DataFrame<R, string> ReadDataFrame<R>(
	this IDataReader reader,
	string keyColumn,
	IEnumerable<string> columnKeys,
	int capacity = 1000,
	bool dropKeyColumn = true
)
<ExtensionAttribute>
Public Shared Function ReadDataFrame(Of R) ( 
	reader As IDataReader,
	keyColumn As String,
	columnKeys As IEnumerable(Of String),
	Optional capacity As Integer = 1000,
	Optional dropKeyColumn As Boolean = true
) As DataFrame(Of R, String)
public:
[ExtensionAttribute]
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	IDataReader^ reader, 
	String^ keyColumn, 
	IEnumerable<String^>^ columnKeys, 
	int capacity = 1000, 
	bool dropKeyColumn = true
)
[<ExtensionAttribute>]
static member ReadDataFrame : 
        reader : IDataReader * 
        keyColumn : string * 
        columnKeys : IEnumerable<string> * 
        ?capacity : int * 
        ?dropKeyColumn : bool 
(* Defaults:
        let _capacity = defaultArg capacity 1000
        let _dropKeyColumn = defaultArg dropKeyColumn true
*)
-> DataFrame<'R, string> 

Parameters

reader
Type: System.DataIDataReader
An IDataReader.
keyColumn
Type: SystemString
The name of the column that contains the row index values.
columnKeys
Type: System.Collections.GenericIEnumerableString
A sequence of column names.
capacity (Optional)
Type: SystemInt32
Optional. The initial capacity for the data frame.
dropKeyColumn (Optional)
Type: SystemBoolean
Optional. Specifies whether the key column should be removed from the data frame. The default is .

Type Parameters

R
The element type of the row index.

Return Value

Type: DataFrameR, String
The data frame with the columns specified by columnKeys read from reader.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IDataReader. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks

Optimal performance is achieved when capacity is equal to the number of rows in the data frame.

See Also

Reference

DataExtensions Class
ReadDataFrame Overload
Extreme.Data Namespace

Copyright (c) 2004-2021 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.