chiark - git - mdw - catacomb/blob - math/mp-fibonacci.h

   1 /* -*-c-*-
   2  *
   3  * Compute the %$n$%th Fibonacci number
   4  *
   5  * (c) 2013 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Catacomb.
  11  *
  12  * Catacomb is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * Catacomb is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with Catacomb; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 #ifndef CATACOMB_MP_FIBONACCI_H
  29 #define CATACOMB_MP_FIBONACCI_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #ifndef CATACOMB_MP_H
  38 #  include "mp.h"
  39 #endif
  40
  41 /*----- Functions provided ------------------------------------------------*/
  42
  43 /* --- @mp_fibonacci@ --- *
  44  *
  45  * Arguments:   @long n@ = index desired (may be negative)
  46  *
  47  * Returns:     The %$n$%th Fibonacci number.
  48  */
  49
  50 extern mp *mp_fibonacci(long /*n*/);
  51
  52 /*----- That's all, folks -------------------------------------------------*/
  53
  54 #ifdef __cplusplus
  55   }
  56 #endif
  57
  58 #endif