| SeriesModuleZipAlignK, V1, V2 Method |
Align and zip two series using the specified joining mechanism and key matching.
The function returns a series of tuples where both elements may be missing. As a result,
it is often easier to use join on frames instead.
## Parameters
- `kind` specifies the kind of join you want to use (left, right, inner or outer).
For inner join, it is better to use `zipInner` instead.
- `lookup` specifies how matching keys are found when left or right join is used
on a sorted series. Use this to find the nearest smaller or nearest greater key
in the other series.
Supported values are `Lookup.Exact`, `Lookup.ExactOrSmaller` and `Lookup.ExactOrGreater`.
- `series1` - The first (left) series to be aligned
- `series2` - The second (right) series to be aligned
[category:Joining, merging and zipping]
Namespace:
Deedle
Assembly:
Deedle (in Deedle.dll) Version: 1.2
Syntax public static Series<K, Tuple<OptionalValue<V1>, OptionalValue<V2>>> ZipAlign<K, V1, V2>(
JoinKind kind,
Lookup lookup,
Series<K, V1> series1,
Series<K, V2> series2
)
Parameters
- kind
- Type: DeedleJoinKind
[Missing <param name="kind"/> documentation for "M:Deedle.SeriesModule.ZipAlign``3(Deedle.JoinKind,Deedle.Lookup,Deedle.Series{``0,``1},Deedle.Series{``0,``2})"]
- lookup
- Type: DeedleLookup
[Missing <param name="lookup"/> documentation for "M:Deedle.SeriesModule.ZipAlign``3(Deedle.JoinKind,Deedle.Lookup,Deedle.Series{``0,``1},Deedle.Series{``0,``2})"]
- series1
- Type: DeedleSeriesK, V1
[Missing <param name="series1"/> documentation for "M:Deedle.SeriesModule.ZipAlign``3(Deedle.JoinKind,Deedle.Lookup,Deedle.Series{``0,``1},Deedle.Series{``0,``2})"]
- series2
- Type: DeedleSeriesK, V2
[Missing <param name="series2"/> documentation for "M:Deedle.SeriesModule.ZipAlign``3(Deedle.JoinKind,Deedle.Lookup,Deedle.Series{``0,``1},Deedle.Series{``0,``2})"]
Type Parameters
- K
- V1
- V2
Return Value
Type:
SeriesK,
TupleOptionalValueV1,
OptionalValueV2[Missing <returns> documentation for "M:Deedle.SeriesModule.ZipAlign``3(Deedle.JoinKind,Deedle.Lookup,Deedle.Series{``0,``1},Deedle.Series{``0,``2})"]
See Also