gonum.org/v1/gonum@v0.14.0/unit/volume.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  // Volume represents a volume in cubic metres.
    17  type Volume float64
    18  
    19  const Litre Volume = 1e-3
    20  
    21  // Unit converts the Volume to a *Unit.
    22  func (v Volume) Unit() *Unit {
    23  	return New(float64(v), Dimensions{
    24  		LengthDim: 3,
    25  	})
    26  }
    27  
    28  // Volume allows Volume to implement a Volumeer interface.
    29  func (v Volume) Volume() Volume {
    30  	return v
    31  }
    32  
    33  // From converts the unit into the receiver. From returns an
    34  // error if there is a mismatch in dimension.
    35  func (v *Volume) From(u Uniter) error {
    36  	if !DimensionsMatch(u, Litre) {
    37  		*v = Volume(math.NaN())
    38  		return errors.New("unit: dimension mismatch")
    39  	}
    40  	*v = Volume(u.Unit().Value())
    41  	return nil
    42  }
    43  
    44  func (v Volume) Format(fs fmt.State, c rune) {
    45  	switch c {
    46  	case 'v':
    47  		if fs.Flag('#') {
    48  			fmt.Fprintf(fs, "%T(%v)", v, float64(v))
    49  			return
    50  		}
    51  		fallthrough
    52  	case 'e', 'E', 'f', 'F', 'g', 'G':
    53  		p, pOk := fs.Precision()
    54  		w, wOk := fs.Width()
    55  		const unit = " m^3"
    56  		switch {
    57  		case pOk && wOk:
    58  			fmt.Fprintf(fs, "%*.*"+string(c), pos(w-utf8.RuneCount([]byte(unit))), p, float64(v))
    59  		case pOk:
    60  			fmt.Fprintf(fs, "%.*"+string(c), p, float64(v))
    61  		case wOk:
    62  			fmt.Fprintf(fs, "%*"+string(c), pos(w-utf8.RuneCount([]byte(unit))), float64(v))
    63  		default:
    64  			fmt.Fprintf(fs, "%"+string(c), float64(v))
    65  		}
    66  		fmt.Fprint(fs, unit)
    67  	default:
    68  		fmt.Fprintf(fs, "%%!%c(%T=%g m^3)", c, v, float64(v))
    69  	}
    70  }