Metadata-Version: 2.0
Name: fixedpoint
Version: 1.0.0a0
Summary: Fixed point arithmetic library
Home-page: https://fixedpoint.readthedocs.io/en/stable/
Author: Zack Sheffield
Author-email: zack_sheffield@selinc.com
Maintainer: Zack Sheffield
Maintainer-email: zack_sheffield@selinc.com
License: BSD 3-Clause License
Download-URL: https://github.com/Schweitzer-Engineering-Laboratories/fixedpoint
Project-URL: Bug Tracker, https://github.com/Schweitzer-Engineering-Laboratories/fixedpoint/issues
Project-URL: Documentation, https://fixedpoint.readthedocs.io/en/stable/
Project-URL: Source Code, https://github.com/Schweitzer-Engineering-Laboratories/fixedpoint
Keywords: fixed-point,arithmetic
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/x-rst

The fixedpoint package offers several features that are widely used in
DSP applications:

* Generate fixed point numbers from
  string literals,
  integers, or
  floating point numbers.
* Specify bit widths and signedness, or allow it to be deduced
* Various rounding methods
* Various overflow handling methods
* Configurable alerts for
  overflow,
  property mismatches, and
  implicit casting errors
* Arithmetic operations such as
  addition,
  subtraction,
  multiplication,
  exponentiation
* Bitwise operations AND, OR, XOR, and
  inversion.
* Type casting to int, float, bool, str
* Built-in string formatting
  (f-strings or str.format)
* Comparisons with other FixedPoint, int, or
  float objects

The fixedpoint package is unit-tested against MATLAB stimulus (with the fixed
point toolbox), making the fixedpoint package a viable, accurate, and
cost-free alternative to MATLAB.


BSD 3-Clause License

Copyright (c) 2020, Schweitzer Engineering Laboratories
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


