github.com/klaytn/klaytn@v1.12.1/common/math/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2015 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from common/math/big.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package math provides convenience functions to use big.Int and to parse a string into an integer.
    23  
    24  `big.go` provides Max, Min, Pow, and Parse functions for big.Int type and it also implements encoding.TextMarshaler and encoding.TextUnmarshaler.
    25  
    26  `integer.go` provides functions to parse string into unsigned int and to calculate safely by detecting overflow. It also provides implementation of encoding.TextMarshaler and encoding.TextUnmarshaler.
    27  
    28  encoding.TextMarshaler is the interface implemented by an object that can marshal itself into a textual form. Its MarshalText encodes the receiver into UTF-8-encoded text and returns the result.
    29  
    30  encoding.TextUnmarshaler is the interface implemented by an object that can unmarshal a textual representation of itself. Its UnmarshalText must be able to decode the form generated by MarshalText.
    31  */
    32  package math