OpenDiablo2/d2common/d2math/doc.go

// Package d2math provides mathematical functions not included in Golang's standard math library.
/*
The decimal numeric type used is float64.

Math also dictates the threshold for approximate equality (d2math.Epsilon). This is currently used both for moving
entities and for approximate floating point equality in vector functions. See d2vector.*/
package d2math
Map entity rework - vectors in mapEntity (#579) * Fixed NaN on normalize 0 vector. * Tentative implementation in getStepLength. * mapEntity.TileX/Y removed. * Fixed Position and Target not being initialised in createMapEntity. * mapEntity.Position is no longer embedded. * mapEntity.LocationX/Y no longer used outside map_entity.go. * mapEntity.subCellX/Y removed. * mapEntity.LocationX/Y removed. * mapEntity.OffsetX/Y and TargetX/Y removed. * Direction method added to Vector, returns 0-64 direction. * Moved Vector.Direction() to Position.DirectionTo and refactored. * Renamed RenderOffset from SubCell and tested IsZero. * d2math.WrapInt added for use with directions. * Tidied up position and tests. * Refactored d2common.AdjustWithRemainder into d2mapEntity. * Tidying up d2mapEntity. * Final cleanup. * Lint warnings. * Spelling correction. 2020-07-13 09:06:50 -04:00			`// Package d2math provides mathematical functions not included in Golang's standard math library.`
Benchmark d2math (#595) * Vector and tests reviewed. * Tests and benchmarks for d2math.math. Also docs/comments. 2020-07-17 18:50:07 -04:00			`/*`
			`The decimal numeric type used is float64.`

			`Math also dictates the threshold for approximate equality (d2math.Epsilon). This is currently used both for moving`
			`entities and for approximate floating point equality in vector functions. See d2vector.*/`
moving package comments into doc.go files (#534) 2020-07-03 18:33:46 -04:00			`package d2math`