avgmax.go

// Copyright (c) 2019, The Goki Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package minmax

import "fmt"

//gosl: start minmax

const (
	MaxFloat32 float32 = 3.402823466e+38
	MinFloat32 float32 = 1.175494351e-38
)

// AvgMax holds average and max statistics
type AvgMax32 struct {
	Avg float32
	Max float32

	// sum for computing average
	Sum float32

	// index of max item
	MaxIndex int32

	// number of items in sum
	N int32

	pad, pad1, pad2 int32
}

// Init initializes prior to new updates
func (am *AvgMax32) Init() {
	am.Avg = 0
	am.Sum = 0
	am.N = 0
	am.Max = -MaxFloat32
	am.MaxIndex = -1
}

// UpdateVal updates stats from given value
func (am *AvgMax32) UpdateValue(val float32, idx int32) {
	am.Sum += val
	am.N++
	if val > am.Max {
		am.Max = val
		am.MaxIndex = idx
	}
}

// UpdateFromOther updates these values from other AvgMax32 values
func (am *AvgMax32) UpdateFromOther(oSum, oMax float32, oN, oMaxIndex int32) {
	am.Sum += oSum
	am.N += oN
	if oMax > am.Max {
		am.Max = oMax
		am.MaxIndex = oMaxIndex
	}
}

// CalcAvg computes the average given the current Sum and N values
func (am *AvgMax32) CalcAvg() {
	if am.N > 0 {
		am.Avg = am.Sum / float32(am.N)
	} else {
		am.Avg = am.Sum
		am.Max = am.Avg // prevents Max from being -MaxFloat..
	}
}

//gosl: end minmax

func (am *AvgMax32) String() string {
	return fmt.Sprintf("{Avg: %g, Max: %g, Sum: %g, MaxIndex: %d, N: %d}", am.Avg, am.Max, am.Sum, am.MaxIndex, am.N)
}

// UpdateFrom updates these values from other AvgMax32 values
func (am *AvgMax32) UpdateFrom(oth *AvgMax32) {
	am.UpdateFromOther(oth.Sum, oth.Max, oth.N, oth.MaxIndex)
	am.Sum += oth.Sum
	am.N += oth.N
	if oth.Max > am.Max {
		am.Max = oth.Max
		am.MaxIndex = oth.MaxIndex
	}
}

// CopyFrom copies from other AvgMax32
func (am *AvgMax32) CopyFrom(oth *AvgMax32) {
	*am = *oth
}

///////////////////////////////////////////////////////////////////////////
//  64

// AvgMax holds average and max statistics
type AvgMax64 struct {
	Avg float64
	Max float64

	// sum for computing average
	Sum float64

	// index of max item
	MaxIndex int32

	// number of items in sum
	N int32
}

// Init initializes prior to new updates
func (am *AvgMax64) Init() {
	am.Avg = 0
	am.Sum = 0
	am.N = 0
	am.Max = -MaxFloat64
	am.MaxIndex = -1
}

// UpdateVal updates stats from given value
func (am *AvgMax64) UpdateValue(val float64, idx int) {
	am.Sum += val
	am.N++
	if val > am.Max {
		am.Max = val
		am.MaxIndex = int32(idx)
	}
}

// CalcAvg computes the average given the current Sum and N values
func (am *AvgMax64) CalcAvg() {
	if am.N > 0 {
		am.Avg = am.Sum / float64(am.N)
	} else {
		am.Avg = am.Sum
		am.Max = am.Avg // prevents Max from being -MaxFloat..
	}
}

// UpdateFrom updates these values from other AvgMax64
func (am *AvgMax64) UpdateFrom(oth *AvgMax64) {
	am.Sum += oth.Sum
	am.N += oth.N
	if oth.Max > am.Max {
		am.Max = oth.Max
		am.MaxIndex = oth.MaxIndex
	}
}

// CopyFrom copies from other AvgMax64
func (am *AvgMax64) CopyFrom(oth *AvgMax64) {
	am.Avg = oth.Avg
	am.Max = oth.Max
	am.MaxIndex = oth.MaxIndex
	am.Sum = oth.Sum
	am.N = oth.N
}