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
  • 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

Skip Navigation LinksHome»Documentation»Reference»Extreme.DataAnalysis»DataFrame Class»Methods»JoinOnNearest(R, C) Method

DataFrameJoinOnNearestR, C Method

Extreme Optimization Numerical Libraries for .NET Professional
Returns a new data frame by joining a data frames on the nearest keys in their row indexes.

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

C#
VB
C++
F#
Copy
public static DataFrame<R, C> JoinOnNearest<R, C>(
	this DataFrame<R, C> left,
	DataFrame<R, C> right,
	Direction direction,
	Func<C, C> thisKeyModifier = null,
	Func<C, C> rightKeyModifier = null
)
<ExtensionAttribute>
Public Shared Function JoinOnNearest(Of R, C) ( 
	left As DataFrame(Of R, C),
	right As DataFrame(Of R, C),
	direction As Direction,
	Optional thisKeyModifier As Func(Of C, C) = Nothing,
	Optional rightKeyModifier As Func(Of C, C) = Nothing
) As DataFrame(Of R, C)
public:
[ExtensionAttribute]
generic<typename R, typename C>
static DataFrame<R, C>^ JoinOnNearest(
	DataFrame<R, C>^ left, 
	DataFrame<R, C>^ right, 
	Direction direction, 
	Func<C, C>^ thisKeyModifier = nullptr, 
	Func<C, C>^ rightKeyModifier = nullptr
)
[<ExtensionAttribute>]
static member JoinOnNearest : 
        left : DataFrame<'R, 'C> * 
        right : DataFrame<'R, 'C> * 
        direction : Direction * 
        ?thisKeyModifier : Func<'C, 'C> * 
        ?rightKeyModifier : Func<'C, 'C> 
(* Defaults:
        let _thisKeyModifier = defaultArg thisKeyModifier null
        let _rightKeyModifier = defaultArg rightKeyModifier null
*)
-> DataFrame<'R, 'C> 

Parameters

left
Type: Extreme.DataAnalysisDataFrameR, C
The data frame that serves as the left operand of the join operation.
right
Type: Extreme.DataAnalysisDataFrameR, C
The data frame that serves as the right operand of the join operation.
direction
Type: Extreme.DataAnalysisDirection
The direction to look for the key if an exact match is not found.
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 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

Type: DataFrameR, 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 DataFrameR, 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

ExceptionCondition
ArgumentNullException

right is .

See Also

Reference

DataFrame Class
Extreme.DataAnalysis Namespace

Copyright (c) 2004-2023 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2023, 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.