timeseq

Time sequence.

This package defines some simple types like Int64Seq Float64Seq for time series data, and provides useful methods to deal with them, you can Merge, Trim or Aggregate your data.

Install

Requires a Go version with modules support.

go get github.com/gochore/timeseq/v2

Example

See more in doc or wiki.

package main

import (
	"fmt"
	"time"

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

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

	// define a data point
	elem := timeseq.Int{
		Time:  now,
		Value: 1,
	}

	// define a data series
	slice := timeseq.Ints{
		{
			Time:  now.Add(time.Second),
			Value: 1,
		},
		{
			Time:  now.Add(-time.Second),
			Value: 2,
		},
	}

	// you can append and modify slice
	slice = append(slice, elem)
	slice[0].Value = 100
	slice[1].Time = now.Add(time.Hour)

	// define a seq according to the slice, it will copy and sort data
	seq := timeseq.NewIntSeq(slice)

	// now you can not modify or add elem to seq, seq has protected slice inside
	elem = seq.Index(0)
	elem.Value = 100 // not work, it do not changed the data in seq

	// for better performance, you can use existing slice as inside data
	seq = timeseq.WrapIntSeq(slice)

	// it should be noted that you should not modify the slice any longer
	// slice[0].Value = 0 // please don't do that!

	// 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(timeseq.After(now))
	// 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.Int) (stop bool) {
		fmt.Println(i, v.Time, v.Value)
		return false
	})

	// merge data
	seq2 := timeseq.WrapIntSeq(timeseq.Ints{
		{
			Time:  now.Add(time.Second),
			Value: 1,
		},
		{
			Time:  now.Add(-time.Second),
			Value: 2,
		},
	})
	newSeq := seq.Merge(func(t time.Time, v1, v2 *int) *int {
		if v1 == nil {
			return v2
		}
		if v2 == nil {
			return v1
		}
		ret := *v1 + *v2
		return &ret
	}, seq2)

	_ = newSeq
}