ghistogram

package module

v0.0.0 Latest Latest Go to latest Published: Jun 23, 2015 License: Apache-2.0 Imports: 1 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/couchbaselabs/ghistogram

Links

Open Source Insights

README ¶

ghistogram

Simple histogram for golang that avoids runtime memory allocations.

Documentation ¶

Overview ¶

Package ghistogram provides a simple histogram of ints that avoids heap allocations (garbage creation) during data processing.

Index ¶

type Histogram
- func NewHistogram(numBins int, binFirst int, binGrowthFactor float64) *Histogram
- func (gh *Histogram) Add(dataPoint int, count uint64)
- func (gh *Histogram) AddAll(src *Histogram)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Histogram ¶

type Histogram struct {
	Ranges []int // Lower bound of bin, so Ranges[0] == binStart.
	Counts []uint64
}

Histogram is a simple int histogram implementation that avoids heap allocations (garbage creation) during its processing of incoming data points.

The histogram bins are split across arrays of Ranges and Counts, where len(Ranges) == len(Counts). These arrays are public in case users wish to use reflection or JSON marhsallings.

Concurrent access (e.g., locking) on a Histogram is a responsibility of the user's application.

func NewHistogram ¶

func NewHistogram(
	numBins int,
	binFirst int,
	binGrowthFactor float64) *Histogram

NewHistogram creates a new, ready to use Histogram. The numBins must be >= 2. The binFirst is the width of the first bin. The binGrowthFactor must be > 1.0.

func (*Histogram) Add ¶

func (gh *Histogram) Add(dataPoint int, count uint64)

Add increases the count in the bin for the given dataPoint.

func (*Histogram) AddAll ¶

func (gh *Histogram) AddAll(src *Histogram)

AddAll adds all the Counts from the src histogram into this histogram. The src and this histogram must either have the same exact creation parameters.

Source Files ¶

View all Source files

ghistogram.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL