DataFrame.JoinOnSharedColumns<R1, R2, C> Method

Returns a new data frame by joining two data frames on their shared columns.

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

public static DataFrame<long, C> JoinOnSharedColumns<R1, R2, C>(
	this DataFrame<R1, C> left,
	JoinType joinType,
	DataFrame<R2, C> right,
	bool sort = true
)

Visual Basic

<ExtensionAttribute>
Public Shared Function JoinOnSharedColumns(Of R1, R2, C) ( 
	left As DataFrame(Of R1, C),
	joinType As JoinType,
	right As DataFrame(Of R2, C),
	Optional sort As Boolean = true
) As DataFrame(Of Long, C)

C++/CLI

public:
[ExtensionAttribute]
generic<typename R1, typename R2, typename C>
static DataFrame<long long, C>^ JoinOnSharedColumns(
	DataFrame<R1, C>^ left, 
	JoinType joinType, 
	DataFrame<R2, C>^ right, 
	bool sort = true
)

[<ExtensionAttribute>]
static member JoinOnSharedColumns : 
        left : DataFrame<'R1, 'C> * 
        joinType : JoinType * 
        right : DataFrame<'R2, 'C> * 
        ?sort : bool 
(* Defaults:
        let _sort = defaultArg sort true
*)
-> DataFrame<int64, 'C>

Parameters

left DataFrame<R1, C>: A data frame.
joinType JoinType: The type of join operation to perform.
right DataFrame<R2, C>: A data frame.
sort Boolean (Optional): If true, sort the resulting data frame on the join column(s).

Type Parameters

R1: The element type of the row index of the left data frame.
R2: The element type of the row index of the right data frame.
C: The element type of the column index of the data frames.

Return Value

DataFrame<Int64, C>
The joined data frame.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type DataFrame<R1, C>. 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).

Exceptions

ArgumentNullException	right is null.
InvalidOperationException	The two data frames don't have any columns in common.