gonum.org/v1/gonum@v0.14.0/unit/energy.go (about)

     1  // Code generated by "go generate gonum.org/v1/gonum/unit”; DO NOT EDIT.
     2  
     3  // Copyright ©2014 The Gonum Authors. All rights reserved.
     4  // Use of this source code is governed by a BSD-style
     5  // license that can be found in the LICENSE file.
     6  
     7  package unit
     8  
     9  import (
    10  	"errors"
    11  	"fmt"
    12  	"math"
    13  	"unicode/utf8"
    14  )
    15  
    16  // Energy represents a quantity of energy in Joules.
    17  type Energy float64
    18  
    19  const Joule Energy = 1
    20  
    21  // Unit converts the Energy to a *Unit.
    22  func (e Energy) Unit() *Unit {
    23  	return New(float64(e), Dimensions{
    24  		LengthDim: 2,
    25  		MassDim:   1,
    26  		TimeDim:   -2,
    27  	})
    28  }
    29  
    30  // Energy allows Energy to implement a Energyer interface.
    31  func (e Energy) Energy() Energy {
    32  	return e
    33  }
    34  
    35  // From converts the unit into the receiver. From returns an
    36  // error if there is a mismatch in dimension.
    37  func (e *Energy) From(u Uniter) error {
    38  	if !DimensionsMatch(u, Joule) {
    39  		*e = Energy(math.NaN())
    40  		return errors.New("unit: dimension mismatch")
    41  	}
    42  	*e = Energy(u.Unit().Value())
    43  	return nil
    44  }
    45  
    46  func (e Energy) Format(fs fmt.State, c rune) {
    47  	switch c {
    48  	case 'v':
    49  		if fs.Flag('#') {
    50  			fmt.Fprintf(fs, "%T(%v)", e, float64(e))
    51  			return
    52  		}
    53  		fallthrough
    54  	case 'e', 'E', 'f', 'F', 'g', 'G':
    55  		p, pOk := fs.Precision()
    56  		w, wOk := fs.Width()
    57  		const unit = " J"
    58  		switch {
    59  		case pOk && wOk:
    60  			fmt.Fprintf(fs, "%*.*"+string(c), pos(w-utf8.RuneCount([]byte(unit))), p, float64(e))
    61  		case pOk:
    62  			fmt.Fprintf(fs, "%.*"+string(c), p, float64(e))
    63  		case wOk:
    64  			fmt.Fprintf(fs, "%*"+string(c), pos(w-utf8.RuneCount([]byte(unit))), float64(e))
    65  		default:
    66  			fmt.Fprintf(fs, "%"+string(c), float64(e))
    67  		}
    68  		fmt.Fprint(fs, unit)
    69  	default:
    70  		fmt.Fprintf(fs, "%%!%c(%T=%g J)", c, e, float64(e))
    71  	}
    72  }