package timeseries

Import Path
	golang.org/x/net/internal/timeseries (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d timeseries.go
		Package timeseries implements a time series structure for stats collection.
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Clock (interface)
		A Clock tells the current time.

		Methods (only one)
			( Clock) Time() time.Time
		Implemented By (at least 8)
			 github.com/chromedp/cdproto/cdp.MonotonicTime
			 github.com/chromedp/cdproto/cdp.TimeSinceEpoch
			 github.com/chromedp/cdproto/cdp.TimeSinceEpochMilli
			 github.com/chromedp/cdproto/input.TimeSinceEpoch
			 github.com/chromedp/cdproto/runtime.Timestamp
			 github.com/pion/webrtc/v4.StatsTimestamp
			 github.com/prometheus/common/model.Time
			 log/slog.Value
		As Inputs Of (at least 2)
			func NewMinuteHourSeriesWithClock(f func() Observable, clock Clock) *MinuteHourSeries
			func NewTimeSeriesWithClock(f func() Observable, clock Clock) *TimeSeries

	 type Float float64 (basic type)
		Float attaches the methods of Observable to a float64.

		Methods (total 6)
			(*Float) Add(other Observable)
			(*Float) Clear()
			(*Float) CopyFrom(other Observable)
			(*Float) Multiply(ratio float64)
			(*Float) String() string
				String returns the float as a string.

			(*Float) Value() float64
				Value returns the float's value.

		Implements (at least 3)
			*Float : Observable
			*Float : expvar.Var
			*Float : fmt.Stringer

	 type MinuteHourSeries (struct)
		MinuteHourSeries tracks data at granularities of 1 minute and 1 hour.

		Methods (total 13)
			(*MinuteHourSeries) Add(observation Observable)
				Add records an observation at the current time.

			(*MinuteHourSeries) AddWithTime(observation Observable, t time.Time)
				AddWithTime records an observation at the specified time.

			(*MinuteHourSeries) Clear()
				Clear removes all observations from the time series.

			(*MinuteHourSeries) ComputeRange(start, finish time.Time, num int) []Observable
				ComputeRange computes a specified number of values into a slice using
				the observations recorded over the specified time period. The return
				values are approximate if the start or finish times don't fall on the
				bucket boundaries at the same level or if the number of buckets spanning
				the range is not an integral multiple of num.

			(*MinuteHourSeries) Hour() Observable
			(*MinuteHourSeries) Latest(level, num int) Observable
				Latest returns the sum of the num latest buckets from the level.

			(*MinuteHourSeries) LatestBuckets(level, num int) []Observable
				LatestBuckets returns a copy of the num latest buckets from level.

			(*MinuteHourSeries) Minute() Observable
			(*MinuteHourSeries) Range(start, finish time.Time) Observable
				Range returns the sum of observations added over the specified time range.
				If start or finish times don't fall on bucket boundaries of the same
				level, then return values are approximate answers.

			(*MinuteHourSeries) Recent(delta time.Duration) Observable
				Recent returns the sum of observations from the last delta.

			(*MinuteHourSeries) RecentList(delta time.Duration, num int) []Observable
				RecentList returns the specified number of values in slice over the most
				recent time period of the specified range.

			(*MinuteHourSeries) ScaleBy(factor float64)
				ScaleBy updates observations by scaling by factor.

			(*MinuteHourSeries) Total() Observable
				Total returns the total of all observations.

		As Outputs Of (at least 2)
			func NewMinuteHourSeries(f func() Observable) *MinuteHourSeries
			func NewMinuteHourSeriesWithClock(f func() Observable, clock Clock) *MinuteHourSeries

	 type Observable (interface)
		An Observable is a kind of data that can be aggregated in a time series.

		Methods (total 4)
			( Observable) Add(other Observable)
				// Adds the data from a different observation to self

			( Observable) Clear()
				// Clears the observation so it can be reused.

			( Observable) CopyFrom(other Observable)
				// Copies the contents of a given observation to self

			( Observable) Multiply(ratio float64)
				// Multiplies the data in self by a given ratio

		Implemented By (at least one exported)
			*Float
		As Outputs Of (at least 3)
			func NewFloat() Observable
			func (*MinuteHourSeries).Hour() Observable
			func (*MinuteHourSeries).Minute() Observable
		As Inputs Of (at least 4)
			func (*Float).Add(other Observable)
			func (*Float).CopyFrom(other Observable)
			func Observable.Add(other Observable)
			func Observable.CopyFrom(other Observable)

	 type TimeSeries (struct)
		TimeSeries tracks data at granularities from 1 second to 16 weeks.

		Methods (total 11)
			(*TimeSeries) Add(observation Observable)
				Add records an observation at the current time.

			(*TimeSeries) AddWithTime(observation Observable, t time.Time)
				AddWithTime records an observation at the specified time.

			(*TimeSeries) Clear()
				Clear removes all observations from the time series.

			(*TimeSeries) ComputeRange(start, finish time.Time, num int) []Observable
				ComputeRange computes a specified number of values into a slice using
				the observations recorded over the specified time period. The return
				values are approximate if the start or finish times don't fall on the
				bucket boundaries at the same level or if the number of buckets spanning
				the range is not an integral multiple of num.

			(*TimeSeries) Latest(level, num int) Observable
				Latest returns the sum of the num latest buckets from the level.

			(*TimeSeries) LatestBuckets(level, num int) []Observable
				LatestBuckets returns a copy of the num latest buckets from level.

			(*TimeSeries) Range(start, finish time.Time) Observable
				Range returns the sum of observations added over the specified time range.
				If start or finish times don't fall on bucket boundaries of the same
				level, then return values are approximate answers.

			(*TimeSeries) Recent(delta time.Duration) Observable
				Recent returns the sum of observations from the last delta.

			(*TimeSeries) RecentList(delta time.Duration, num int) []Observable
				RecentList returns the specified number of values in slice over the most
				recent time period of the specified range.

			(*TimeSeries) ScaleBy(factor float64)
				ScaleBy updates observations by scaling by factor.

			(*TimeSeries) Total() Observable
				Total returns the total of all observations.

		As Outputs Of (at least 2)
			func NewTimeSeries(f func() Observable) *TimeSeries
			func NewTimeSeriesWithClock(f func() Observable, clock Clock) *TimeSeries


Package-Level Functions (total 5)

	 func NewFloat() Observable
		NewFloat returns a Float.

	 func NewMinuteHourSeries(f func() Observable) *MinuteHourSeries
		NewMinuteHourSeries creates a new MinuteHourSeries using the function provided for creating new Observable.

	 func NewMinuteHourSeriesWithClock(f func() Observable, clock Clock) *MinuteHourSeries
		NewMinuteHourSeriesWithClock creates a new MinuteHourSeries using the function provided for creating new Observable and the clock for
		assigning timestamps.

	 func NewTimeSeries(f func() Observable) *TimeSeries
		NewTimeSeries creates a new TimeSeries using the function provided for creating new Observable.

	 func NewTimeSeriesWithClock(f func() Observable, clock Clock) *TimeSeries
		NewTimeSeriesWithClock creates a new TimeSeries using the function provided for creating new Observable and the clock for
		assigning timestamps.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.