 | FrameExtensionsShiftTRowKey, TColumnKey Method |
Returns a frame with columns shifted by the specified offset. When the offset is
positive, the values are shifted forward and first `offset` keys are dropped. When the
offset is negative, the values are shifted backwards and the last `offset` keys are dropped.
Expressed in pseudo-code:
result[k] = series[k - offset]
## Parameters
- `offset` - Can be both positive and negative number.
- `frame` - The input frame whose columns are to be shifted.
## Remarks
If you want to calculate the difference, e.g. `df - (Frame.shift 1 df)`, you can
use `Frame.diff` which will be a little bit faster.
Namespace: Deedle
Assembly: Deedle (in Deedle.dll) Version: 1.2
SyntaxC#
public static Frame<TRowKey, TColumnKey> Shift<TRowKey, TColumnKey>( this Frame<TRowKey, TColumnKey> frame, int offset )
Parameters
- frame
- Type: DeedleFrameTRowKey, TColumnKey
[Missing <param name="frame"/> documentation for "M:Deedle.FrameExtensions.Shift``2(Deedle.Frame{``0,``1},System.Int32)"]
- offset
- Type: SystemInt32
[Missing <param name="offset"/> documentation for "M:Deedle.FrameExtensions.Shift``2(Deedle.Frame{``0,``1},System.Int32)"]
Type Parameters
- TRowKey
- TColumnKey
Return Value
Type: FrameTRowKey, TColumnKey[Missing <returns> documentation for "M:Deedle.FrameExtensions.Shift``2(Deedle.Frame{``0,``1},System.Int32)"]
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type FrameTRowKey, TColumnKey. 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).See Also