timeseq

Time sequence.

This package defines Seq[T] for time series data, and provides useful methods to deal with them, you can Merge, Filter or Aggregate your data.

Install

go get github.com/gochore/timeseq/v3

Example

See more in doc.

package main

import (
	"fmt"
	"time"

	"github.com/gochore/timeseq/v3"
)

func main() {
	now := time.Now()

	// define a data point
	point := timeseq.NewPoint(now, 0)

	// define a data series
	slice := []timeseq.Point[int]{
		// use the defined point
		point,
		// new point with function
		timeseq.NewPoint(now.Add(time.Second), 1),
		// new point with struct literal
		{
			Time:  now.Add(2 * time.Second),
			Value: 2,
		},
	}

	// define a seq according to the slice, it will sort the points if needed
	seq := timeseq.NewSeq(slice)

	// to avoid unexpected modification, you can use NewSeqCopy to copy the slice
	seq = timeseq.NewSeqCopy(slice)

	// or you can use NewSeqConvert to convert from any slice type
	seq2 := timeseq.NewSeqConvert(
		[]int{1, 2, 3, 4, 5},
		func(p int) timeseq.Point[int] {
			return timeseq.NewPoint(now.Add(time.Duration(p)*time.Second), p)
		},
	)

	// now you enjoy the convenience it brings

	// get time of the first one
	fmt.Println(seq.First().Time)
	// get value of the last one
	fmt.Println(seq.Last().Value)

	// get the sub sequence after now
	seq = seq.Range(now, time.Time{})
	// get the sub sequence's length
	fmt.Println(seq.Len())
	// get the first one of the sub sequence
	fmt.Println(seq.Max().Value)

	// traverse
	seq.Traverse(func(i int, v timeseq.Point[int]) (stop bool) {
		fmt.Println(i, v.Time, v.Value)
		return false
	})

	// merge data
	newSeq := timeseq.Merge(seq, seq2, func(t time.Time, v1, v2 *int) *int {
		if v1 == nil {
			return v2
		}
		if v2 == nil {
			return v1
		}
		ret := *v1 + *v2
		return &ret
	})

	fmt.Println(newSeq.Points())
}