Uses of Enum Class
com.quantfinlib.core.Side
Packages that use Side
Package
Description
Bar-based backtesting engines, execution models and performance analytics.
Core bar and bar-series types used by every analytics package.
Order routing, execution algorithms and the venue models they learn
from.
Market microstructure analytics: impact, liquidity, order-flow signals
and intraday curves.
Benchmark-fix and regulatory execution metrics.
Risk measurement, decomposition, limits and model validation.
-
Uses of Side in com.quantfinlib.backtest
Methods in com.quantfinlib.backtest that return SideMethods in com.quantfinlib.backtest with parameters of type SideModifier and TypeMethodDescriptionExecutes up torequestedQtyon this bar.default voidExecutionModel.onParentOrder(Side side, long totalQuantity, int signalIndex) Notification that a new parent order has been created (entry or exit).voidIcebergExecution.onParentOrder(Side side, long totalQuantity, int signalIndex) voidLastLookExecution.onParentOrder(Side side, long totalQuantity, int signalIndex) ExecutionAlgoBacktester.run(BarSeries series, Side side, long parentQty, BenchmarkExecutor.Benchmark benchmark) ExecutionAlgoBacktester.run(BarSeries, Side, long, BenchmarkExecutor.Benchmark, double)for the time/volume benchmarks (no POV rate needed).ExecutionAlgoBacktester.run(BarSeries series, Side side, long parentQty, BenchmarkExecutor.Benchmark benchmark, double povRate) WorksparentQtythrough the session underbenchmarkand grades it.Constructors in com.quantfinlib.backtest with parameters of type SideModifierConstructorDescriptionParentOrder(Side side, int signalIndex, double arrivalPrice, String reason, List<Execution> fills, int[] fillBarIndices) Creates the value; array and collection arguments are copied. -
Uses of Side in com.quantfinlib.core
Subclasses with type arguments of type Side in com.quantfinlib.coreMethods in com.quantfinlib.core that return Side -
Uses of Side in com.quantfinlib.execution
Methods in com.quantfinlib.execution that return SideModifier and TypeMethodDescriptionBenchmarkExecutor.side()VenueBenchmark.Sample.side()Returns the value of thesiderecord component.Methods in com.quantfinlib.execution with parameters of type SideModifier and TypeMethodDescriptionstatic BenchmarkExecutorBenchmarkExecutor.of(Side side, long parentQty, BenchmarkExecutor.Benchmark benchmark) Sensible defaults: alpha urgency 1 (a full-scale normalized alpha of ±1 doubles/halves the pace, smoothly and never rail-pinned), child capped at 25% of displayed depth.static BenchmarkExecutorPOV convenience.longDarkPoolSimulator.restingQty(Side side) Total hidden resting quantity on a side (for simulation introspection only).AdaptiveSor.route(Side side, long quantity, List<VenueQuote> venues) Routes a marketable parent ofquantity.longRoutes a marketable order across venues by best all-in price (quote ± fee), splitting at displayed size.static SmartOrderRouter.RoutingPlanSmartOrderRouter.route(Side side, long quantity, List<VenueQuote> venues, boolean preferDark) static SmartOrderRouter.RoutingPlanSmartOrderRouter.route(Side side, long quantity, List<VenueQuote> venues, boolean preferDark, double limitPrice) AsSmartOrderRouter.route(Side, long, List, boolean), but skips any venue whose price would violatelimitPrice(through-the-limit on the relevant side) — the double-price analogue ofHftSor.route(Side, long, int, long[])'slimitTick.static SmartOrderRouter.RoutingPlanSmartOrderRouter.route(Side side, long quantity, List<VenueQuote> venues, boolean preferDark, double limitPrice, long nowNanos, long maxQuoteAgeNanos) AsSmartOrderRouter.route(Side, long, List, boolean, double), additionally excluding any venue whose quote is stale — the same treatment a NaN or zero-size venue already gets, mirroringHftSor.venueDown(int)as the way a dead/frozen feed is kept from receiving child orders.Submits an order: crosses immediately against resting contra interest at the current mid (time priority), then rests the remainder.Constructors in com.quantfinlib.execution with parameters of type SideModifierConstructorDescriptionBenchmarkExecutor(Side side, long parentQty, BenchmarkExecutor.Benchmark benchmark, double participationRate, double alphaUrgency, double maxDepthFraction) MidPegTracker(Side side, double offset, double limitPrice, double repriceThreshold) Sample(String venue, Side side, double price, long quantity, double midAtExec, double midAfterHorizon, long latencyToFillNanos, boolean filled) Creates an instance of aSamplerecord class. -
Uses of Side in com.quantfinlib.microstructure
Methods in com.quantfinlib.microstructure that return SideModifier and TypeMethodDescriptionExecution.side()Returns the value of thesiderecord component.Constructors in com.quantfinlib.microstructure with parameters of type Side -
Uses of Side in com.quantfinlib.regulatory
Methods in com.quantfinlib.regulatory that return SideModifier and TypeMethodDescriptionBestExecutionAnalyzer.OrderOutcome.side()Returns the value of thesiderecord component.Methods in com.quantfinlib.regulatory with parameters of type SideModifier and TypeMethodDescriptionstatic doubleMarketQualityMetrics.effectiveSpreadBps(Side takerSide, double price, double midAtExecution) Effective spread:2 * sign * (price - mid) / mid— what the taker actually paid.BestExecutionAnalyzer.implementationShortfall(Side side, double decisionPrice, double arrivalPrice, double[] fillQty, double[] fillPrice, double unfilledQty, double closePrice) Decomposes implementation shortfall into its components.static doubleMarketQualityMetrics.priceImpactBps(Side takerSide, double midAtExecution, double midAfterHorizon) Price impact: how far the mid moved in the taker's direction after the trade (2 * sign * (midAfter - midAtExec) / midAtExec); effective spread ≈ realized spread + price impact.static doubleMarketQualityMetrics.realizedSpreadBps(Side takerSide, double price, double midAfterHorizon) Realized spread: effective spread measured against the mid some horizon after the trade — the part of the spread the liquidity provider kept after adverse selection.Constructors in com.quantfinlib.regulatory with parameters of type SideModifierConstructorDescriptionOrderOutcome(String orderId, String venue, Side side, long quantity, double arrivalMid, double executionPrice, long latencyToFillNanos, boolean filled) Creates an instance of aOrderOutcomerecord class. -
Uses of Side in com.quantfinlib.risk
Methods in com.quantfinlib.risk that return SideModifier and TypeMethodDescriptionPreTradeLimitChecker.OrderRequest.side()Returns the value of thesiderecord component.Constructors in com.quantfinlib.risk with parameters of type SideModifierConstructorDescriptionOrderRequest(String symbol, Side side, long quantity, double price, String counterparty) Creates an instance of aOrderRequestrecord class.