DataFrame.Join Method

Definition

Namespace: Extreme.DataAnalysis
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Join<R>(DataFrame<R, String>, DataFrame<R, String>, JoinType, String, String) Returns a new data frame by joining this data frame with another data frame on the data frames' indexes.
Join<R, C>(DataFrame<R, C>, JoinType, DataFrame<R, C>, Func<C, C>, Func<C, C>) Returns a new data frame by joining two data frames on their row indexes.
Join<R1, R2>(DataFrame<R1, String>, JoinType, DataFrame<R2, String>, IList<String>, String, String) Returns a new data frame by joining this data frame with another data frame on the data frame's indexes.
Join<R1, R2>(DataFrame<R1, String>, JoinType, DataFrame<R2, String>, String, String, String) Returns a new data frame by joining this data frame with another data frame on the data frame's row index.
Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, C, Func<C, C>, Func<C, C>) 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.
Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, Boolean, C, C) Returns a new data frame by joining two data frames on the specified columns in each data frame.
Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, IList<C>, Func<C, C>, Func<C, C>) 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.

Join<R>(DataFrame<R, String>, DataFrame<R, String>, JoinType, String, String)

Returns a new data frame by joining this data frame with another data frame on the data frames' indexes.
C#
public static DataFrame<R, string> Join<R>(
	this DataFrame<R, string> left,
	DataFrame<R, string> right,
	JoinType joinType,
	string leftSuffix = "_x",
	string rightSuffix = "_y"
)

Parameters

left  DataFrame<R, String>
The data frame that serves as the left operand of the join operation.
right  DataFrame<R, String>
The data frame that serves as the right operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
leftSuffix  String  (Optional)
The suffix to add to the key of a column in the left frame to make it unique.
rightSuffix  String  (Optional)
The suffix to add to the key of a column in the right frame to make it unique.

Type Parameters

R
The element type of the row index of the data frames.

Return Value

DataFrame<R, String>
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<R, String>. 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).

Join<R, C>(DataFrame<R, C>, JoinType, DataFrame<R, C>, Func<C, C>, Func<C, C>)

Returns a new data frame by joining two data frames on their row indexes.
C#
public static DataFrame<R, C> Join<R, C>(
	this DataFrame<R, C> left,
	JoinType joinType,
	DataFrame<R, C> right,
	Func<C, C> thisKeyModifier = null,
	Func<C, C> rightKeyModifier = null
)

Parameters

left  DataFrame<R, C>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
right  DataFrame<R, C>
The data frame that serves as the right operand of the join operation.
thisKeyModifier  Func<C, C>  (Optional)
A function that modifies a column key of this data frame to make it unique.
rightKeyModifier  Func<C, C>  (Optional)
A function that modifies a column key of the right data frame to make it unique.

Type Parameters

R
The element type of the row index of the data frames.
C
The element type of the column index of the data frames.

Return Value

DataFrame<R, 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<R, 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.

Join<R1, R2>(DataFrame<R1, String>, JoinType, DataFrame<R2, String>, IList<String>, String, String)

Returns a new data frame by joining this data frame with another data frame on the data frame's indexes.
C#
public static DataFrame<R1, string> Join<R1, R2>(
	this DataFrame<R1, string> left,
	JoinType joinType,
	DataFrame<R2, string> right,
	IList<string> keys,
	string leftSuffix = "_x",
	string rightSuffix = "_y"
)

Parameters

left  DataFrame<R1, String>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
right  DataFrame<R2, String>
The data frame that serves as the right operand of the join operation.
keys  IList<String>
The keys of the columns in the left data frame that are used in the joins.
leftSuffix  String  (Optional)
The suffix to add to the key of a column in the left frame to make it unique.
rightSuffix  String  (Optional)
The suffix to add to the key of a column in the right 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.

Return Value

DataFrame<R1, String>
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, String>. 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).

Join<R1, R2>(DataFrame<R1, String>, JoinType, DataFrame<R2, String>, String, String, String)

Returns a new data frame by joining this data frame with another data frame on the data frame's row index.
C#
public static DataFrame<R1, string> Join<R1, R2>(
	this DataFrame<R1, string> left,
	JoinType joinType,
	DataFrame<R2, string> right,
	string key,
	string leftSuffix = "_x",
	string rightSuffix = "_y"
)

Parameters

left  DataFrame<R1, String>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
right  DataFrame<R2, String>
The data frame that serves as the right operand of the join operation.
key  String
The key of the column in the left data frame that is used in the joins.
leftSuffix  String  (Optional)
The suffix to add to the key of a column in the left frame to make it unique.
rightSuffix  String  (Optional)
The suffix to add to the key of a column in the right 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.

Return Value

DataFrame<R1, String>
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, String>. 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).

Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, C, Func<C, C>, Func<C, C>)

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.
C#
public static DataFrame<R1, C> Join<R1, R2, C>(
	this DataFrame<R1, C> left,
	JoinType joinType,
	DataFrame<R2, C> right,
	C key,
	Func<C, C> thisKeyModifier = null,
	Func<C, C> rightKeyModifier = null
)

Parameters

left  DataFrame<R1, C>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
right  DataFrame<R2, C>
The data frame that serves as the right operand of the join operation.
key  C
The key of the column in the left data frame that is used in the joins.
thisKeyModifier  Func<C, C>  (Optional)
A function that modifies a column key of this data frame to make it unique.
rightKeyModifier  Func<C, C>  (Optional)
A function that modifies a column key of the right 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

DataFrame<R1, 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.

Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, Boolean, C, C)

Returns a new data frame by joining two data frames on the specified columns in each data frame.
C#
public static DataFrame<long, C> Join<R1, R2, C>(
	this DataFrame<R1, C> left,
	JoinType joinType,
	DataFrame<R2, C> right,
	bool sort,
	C leftColumnKey,
	C rightColumnKey
)

Parameters

left  DataFrame<R1, C>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform.
right  DataFrame<R2, C>
The data frame that serves as the right operand of the join operation.
sort  Boolean
If true, sort the resulting data frame on the join column(s).
leftColumnKey  C
The key of the join column in the left data frame..
rightColumnKey  C
The key of the join column in the right data frame..

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.

KeyNotFoundException

This data frame does not contain a column with key leftColumnKey.

-or-

right does not contain a column with key rightColumnKey.

Join<R1, R2, C>(DataFrame<R1, C>, JoinType, DataFrame<R2, C>, IList<C>, Func<C, C>, Func<C, C>)

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.
C#
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
)

Parameters

left  DataFrame<R1, C>
The data frame that serves as the left operand of the join operation.
joinType  JoinType
The type of join operation to perform on the indexes.
right  DataFrame<R2, C>
The data frame that serves as the right operand of the join operation.
keys  IList<C>
The keys of the columns in the left data frame that are used in the joins.
thisKeyModifier  Func<C, C>  (Optional)
A function that modifies a column key of this data frame to make it unique.
rightKeyModifier  Func<C, C>  (Optional)
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

DataFrame<R1, 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.

-or-

keys is null.

See Also