goflux

package
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 2, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package goflux provides technical analysis indicators, strategy rules, and backtesting utilities.

This package includes:

  • Indicators (trend, momentum, volume, moving averages)
  • Rule-based strategies (AND/OR/NOT composition, cross rules)
  • Trading records, positions, and analysis utilities
  • Time series and candle utilities

Index

Constants

View Source 
const (
	BUY  = trading.BUY
	SELL = trading.SELL
)

Re-export constants

Variables

View Source 
var (
	ZERO = decimal.ZERO
	ONE  = decimal.ONE
)

Functions

func And 

func And(r1, r2 trading.Rule) trading.Rule

func Max added in v0.0.3 

func Max(a, b int) int

func Min added in v0.0.3 

func Min(a, b int) int

func NewALMAIndicator added in v0.0.3 

func NewALMAIndicator(ind indicators.Indicator, window int, offset float64, sigma float64) indicators.Indicator

func NewATRRatioIndicator added in v0.0.3 

func NewATRRatioIndicator(atr, price indicators.Indicator) indicators.Indicator

func NewATRRatioIndicatorFromSeries added in v0.0.3 

func NewATRRatioIndicatorFromSeries(s *series.TimeSeries, atrWindow int) indicators.Indicator

func NewAveragePriceIndicator added in v0.0.3 

func NewAveragePriceIndicator(s *series.TimeSeries) indicators.Indicator

func NewBollingerBandwidthIndicator added in v0.0.3 

func NewBollingerBandwidthIndicator(ind indicators.Indicator, window int, k float64) indicators.Indicator

func NewCandle 

func NewCandle(period series.TimePeriod) *series.Candle

func NewClosePriceIndicator 

func NewClosePriceIndicator(s *series.TimeSeries) indicators.Indicator

Re-export indicator functions

func NewConstantIndicator 

func NewConstantIndicator(v float64) indicators.Indicator

func NewCrossDownIndicatorRule 

func NewCrossDownIndicatorRule(upper, lower indicators.Indicator) trading.Rule

func NewCrossUpIndicatorRule 

func NewCrossUpIndicatorRule(upper, lower indicators.Indicator) trading.Rule

func NewDecimal 

func NewDecimal(v float64) decimal.Decimal

Re-export decimal functions

func NewDecimalFromInt 

func NewDecimalFromInt(v int64) decimal.Decimal

func NewDecimalFromString 

func NewDecimalFromString(v string) decimal.Decimal

func NewDecimalFromStringWithError added in v0.0.4 

func NewDecimalFromStringWithError(v string) (decimal.Decimal, error)

func NewEMAIndicator 

func NewEMAIndicator(ind indicators.Indicator, window int) indicators.Indicator

func NewFAMAIndicator added in v0.0.3 

func NewFAMAIndicator(ind indicators.Indicator, fastLimit, slowLimit float64) indicators.Indicator

func NewMAMAIndicator added in v0.0.3 

func NewMAMAIndicator(ind indicators.Indicator, fastLimit, slowLimit float64) indicators.Indicator

func NewMedianPriceIndicator added in v0.0.3 

func NewMedianPriceIndicator(s *series.TimeSeries) indicators.Indicator

func NewPosition 

func NewPosition(entryOrder trading.Order) *trading.Position

func NewRMAIndicator added in v0.0.3 

func NewRMAIndicator(ind indicators.Indicator, window int) indicators.Indicator

func NewSMAIndicator 

func NewSMAIndicator(ind indicators.Indicator, window int) indicators.Indicator

func NewT3Indicator added in v0.0.3 

func NewT3Indicator(ind indicators.Indicator, window int, vFactor float64) indicators.Indicator

func NewTRIMAIndicator added in v0.0.3 

func NewTRIMAIndicator(ind indicators.Indicator, window int) indicators.Indicator

func NewTimePeriod 

func NewTimePeriod(start time.Time, duration time.Duration) series.TimePeriod

func NewTimeSeries 

func NewTimeSeries() *series.TimeSeries

Re-export series functions

func NewTimeSeriesIndicator added in v0.0.3 

func NewTimeSeriesIndicator(s *series.TimeSeries) indicators.Indicator

func NewTradingRecord 

func NewTradingRecord() *trading.TradingRecord

Re-export trading functions

func NewVIDYAIndicator added in v0.0.3 

func NewVIDYAIndicator(ind indicators.Indicator, window int) indicators.Indicator

func NewVWMAIndicator added in v0.0.3 

func NewVWMAIndicator(ind, volume indicators.Indicator, window int) indicators.Indicator

func NewVWMAIndicatorFromSeries added in v0.0.3 

func NewVWMAIndicatorFromSeries(s *series.TimeSeries, window int) indicators.Indicator

func NewWeightedCloseIndicator added in v0.0.3 

func NewWeightedCloseIndicator(s *series.TimeSeries) indicators.Indicator

func Not 

func Not(rule trading.Rule) trading.Rule

func Or 

func Or(r1, r2 trading.Rule) trading.Rule

Types

type Analysis 

type Analysis = analysis.Analysis

Analysis re-exports

type Candle 

type Candle = series.Candle

Re-export types

type Decimal 

type Decimal = decimal.Decimal

Re-export types

type Indicator 

type Indicator = indicators.Indicator

Re-export types

type Order 

type Order = trading.Order

Re-export types

type Position 

type Position = trading.Position

Re-export types

type PositionNewRule 

type PositionNewRule = trading.PositionNewRule

PositionNewRule re-export

type PositionOpenRule 

type PositionOpenRule = trading.PositionOpenRule

type Rule 

type Rule = trading.Rule

Re-export types

type RuleStrategy 

type RuleStrategy = trading.RuleStrategy

Re-export types

type Side 

type Side = trading.OrderSide

Re-export types

type Strategy 

type Strategy = trading.Strategy

Re-export types

type TimePeriod 

type TimePeriod = series.TimePeriod

Re-export types

type TimeSeries 

type TimeSeries = series.TimeSeries

Re-export types

type TotalProfitAnalysis 

type TotalProfitAnalysis = analysis.TotalProfitAnalysis

Analysis re-exports

type TradingRecord 

type TradingRecord = trading.TradingRecord

Re-export types

Source Files

View all Source files

Directories

Path Synopsis
Package telemetry provides opt-in anonymized telemetry for the goflux library.
 Package telemetry provides opt-in anonymized telemetry for the goflux library.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.