This is fpfz.egg.info, produced by makeinfo version 4.7 from
eggdoc-output.texi.

INFO-DIR-SECTION The Algorithmic Language Scheme
START-INFO-DIR-ENTRY
* fpfz.egg: (fpfz.egg).		Floating-point Comparison With Epsilon
END-INFO-DIR-ENTRY


File: fpfz.egg.info,  Node: Top,  Next: About this egg,  Up: (dir)

fpfz egg
********

Floating-point Comparison With Epsilon

Written by Kon Lovett (mailto:klovett@pacbell.net)

   This manual corresponds to version 0.1 of the fpfz extension library
for Chicken Scheme.

* Menu:

* About this egg::
* Documentation::
* License::
* Index::


File: fpfz.egg.info,  Node: About this egg,  Next: Documentation,  Prev: Top,  Up: Top

1 About this egg
****************

* Menu:

* Version history::
* Usage::
* Requirements::


File: fpfz.egg.info,  Node: Version history,  Next: Usage,  Up: About this egg

1.1 Version history
===================

`0.1'
     Initial release


File: fpfz.egg.info,  Node: Usage,  Next: Requirements,  Prev: Version history,  Up: About this egg

1.2 Usage
=========

Load this egg like so:

   `(require-extension fpfz)'


File: fpfz.egg.info,  Node: Requirements,  Prev: Usage,  Up: About this egg

1.3 Requirements
================

This egg requires the following extensions:

   `miscmacros'


File: fpfz.egg.info,  Node: Documentation,  Next: License,  Prev: About this egg,  Up: Top

2 Documentation
***************

Routines to perform floating-point operations with an error
bound. These routines are not some cure-all for floating-point
anomalies, but useful anyway.

* Menu:

* Parameters::
* Predicates::
* Operations::


File: fpfz.egg.info,  Node: Parameters,  Next: Predicates,  Up: Documentation

2.1 Parameters
==============

 -- parameter: (current-fpfz-epsilon [#])
     Sets or returns the error bound.


File: fpfz.egg.info,  Node: Predicates,  Next: Operations,  Prev: Parameters,  Up: Documentation

2.2 Predicates
==============

The formula below are for exposition only; they are not the
actual test.

 -- macro: fpfz=
          (fpfz= A B [EPSILON (current-fpfz-epsilon)])

     |a - b| <= E.

 -- macro: fpfz<>
          (fpfz<> A B [EPSILON (current-fpfz-epsilon)])

     |a - b| > E.

 -- macro: fpfz>
          (fpfz> A B [EPSILON (current-fpfz-epsilon)])

     |a - b| > E.

 -- macro: fpfz<
          (fpfz< A B [EPSILON (current-fpfz-epsilon)])

     |a - b| < E.

 -- macro: fpfz>=
          (fpfz>= A B [EPSILON (current-fpfz-epsilon)])

     |a - b| >= E.

 -- macro: fpfz<=
          (fpfz<= A B [EPSILON (current-fpfz-epsilon)])

     |a - b| <= E.


File: fpfz.egg.info,  Node: Operations,  Prev: Predicates,  Up: Documentation

2.3 Operations
==============

 -- macro: roundn
          (roundn N [ND])

     Nearest number within a given precision, the number of
     decimal digits in the fraction `ND'. When precision
     missing normal 'round' is performed.

 -- macro: fpfzroundn
          (fpfzroundn N [ND])

     Nearest number within a given precision, the number of
     decimal digits in the fraction `ND', & epsilon. When
     precision missing normal 'round' is performed.

 -- macro: fpfzceil
          (fpfzceil N)

     Smallest integer number that is tolerably larger than 					the
     given value.

 -- procedure: fpfzfloor
          (fpfzfloor N)

     Smallest integer number that is tolerably smaller than 					the
     given value.

 -- macro: fpmaxabs
          (fpmaxabs A B)

     Mininum of the absolute value of the arguments.

 -- procedure: calculate-fpfz-epsilon
          (calculate-fpfz-epsilon [FEPS 3.0])

     Returns the system epsilon to within a factor of the real
     epsilon.


File: fpfz.egg.info,  Node: License,  Next: Index,  Prev: Documentation,  Up: Top

3 License
*********


Copyright (c) 2006, Kon Lovett.  All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the Software),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.


File: fpfz.egg.info,  Node: Index,  Prev: License,  Up: Top

Index
*****

 [index ]
* Menu:

* (current-fpfz-epsilon [#]):            Parameters.           (line  7)
* calculate-fpfz-epsilon:                Operations.           (line 38)
* fpfz<:                                 Predicates.           (line 25)
* fpfz<=:                                Predicates.           (line 35)
* fpfz<>:                                Predicates.           (line 15)
* fpfz=:                                 Predicates.           (line 10)
* fpfz>:                                 Predicates.           (line 20)
* fpfz>=:                                Predicates.           (line 30)
* fpfzceil:                              Operations.           (line 21)
* fpfzfloor:                             Operations.           (line 27)
* fpfzroundn:                            Operations.           (line 14)
* fpmaxabs:                              Operations.           (line 33)
* roundn:                                Operations.           (line  7)



Tag Table:
Node: Top236
Node: About this egg579
Node: Version history761
Node: Usage912
Node: Requirements1091
Node: Documentation1267
Node: Parameters1603
Node: Predicates1796
Node: Operations2562
Node: License3635
Node: Index4816

End Tag Table