Returns a new data frame by joining a data frame to another
on the specified columns of the left data frame
and the row index of the right data frame.
Namespace:
Extreme.DataAnalysis
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public static DataFrame<R1, C> Join<R1, R2, C>(
this DataFrame<R1, C> left,
JoinType joinType,
DataFrame<R2, C> right,
IList<C> keys,
Func<C, C> thisKeyModifier = null,
Func<C, C> rightKeyModifier = null
)
<ExtensionAttribute>
Public Shared Function Join(Of R1, R2, C) (
left As DataFrame(Of R1, C),
joinType As JoinType,
right As DataFrame(Of R2, C),
keys As IList(Of C),
Optional thisKeyModifier As Func(Of C, C) = Nothing,
Optional rightKeyModifier As Func(Of C, C) = Nothing
) As DataFrame(Of R1, C)
public:
[ExtensionAttribute]
generic<typename R1, typename R2, typename C>
static DataFrame<R1, C>^ Join(
DataFrame<R1, C>^ left,
JoinType joinType,
DataFrame<R2, C>^ right,
IList<C>^ keys,
Func<C, C>^ thisKeyModifier = nullptr,
Func<C, C>^ rightKeyModifier = nullptr
)
[<ExtensionAttribute>]
static member Join :
left : DataFrame<'R1, 'C> *
joinType : JoinType *
right : DataFrame<'R2, 'C> *
keys : IList<'C> *
?thisKeyModifier : Func<'C, 'C> *
?rightKeyModifier : Func<'C, 'C>
(* Defaults:
let _thisKeyModifier = defaultArg thisKeyModifier null
let _rightKeyModifier = defaultArg rightKeyModifier null
*)
-> DataFrame<'R1, 'C>
Parameters
- left
- Type: Extreme.DataAnalysisDataFrameR1, C
The data frame that serves as the left operand of the join operation. - joinType
- Type: Extreme.DataAnalysisJoinType
The type of join operation to perform on the indexes. - right
- Type: Extreme.DataAnalysisDataFrameR2, C
The data frame that serves as the right operand of the join operation. - keys
- Type: System.Collections.GenericIListC
The keys of the columns in the left data frame
that are used in the joins. - thisKeyModifier (Optional)
- Type: SystemFuncC, C
A function that modifies a column key of this data frame to make it unique. - rightKeyModifier (Optional)
- Type: SystemFuncC, C
A function that modifies a column key of the other data frame to make it unique.
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
Type:
DataFrameR1,
CThe joined data frame.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
DataFrameR1,
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).
Reference