 | FrameExtensionsDiffTRowKey, TColumnKey Method |
Returns a frame with columns containing difference between an original value and
a value at the specified offset. For example, calling `Frame.diff 1 s` returns a
frame where previous column values is subtracted from the current ones. In pseudo-code, the
function behaves as follows:
result[k] = series[k] - series[k - offset]
Columns that cannot be converted to `float` are left without a change.
## Parameters
- `offset` - When positive, subtracts the past values from the current values;
when negative, subtracts the future values from the current values.
- `frame` - The input frame containing at least some `float` columns.
Namespace: Deedle
Assembly: Deedle (in Deedle.dll) Version: 1.2
SyntaxC#
public static Frame<TRowKey, TColumnKey> Diff<TRowKey, TColumnKey>( this Frame<TRowKey, TColumnKey> frame, int offset )
Parameters
- frame
- Type: DeedleFrameTRowKey, TColumnKey
[Missing <param name="frame"/> documentation for "M:Deedle.FrameExtensions.Diff``2(Deedle.Frame{``0,``1},System.Int32)"]
- offset
- Type: SystemInt32
[Missing <param name="offset"/> documentation for "M:Deedle.FrameExtensions.Diff``2(Deedle.Frame{``0,``1},System.Int32)"]
Type Parameters
- TRowKey
- TColumnKey
Return Value
Type: FrameTRowKey, TColumnKey[Missing <returns> documentation for "M:Deedle.FrameExtensions.Diff``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