libcds/src/static_permutation/static_permutation.h

   1 /* static_permutation.h
   2  * Copyright (C) 2008, Francisco Claude, all rights reserved.
   3  *
   4  * Permutation
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef _STATIC_PERMUTATION_H
  23 #define _STATIC_PERMUTATION_H
  24
  25 #include <basics.h>
  26
  27 #define STATIC_PERMUTATION_MRRR_HDR 2
  28
  29 /** Base class for static permutations
  30  *  @author Francisco Claude
  31  */
  32 class static_permutation {
  33   public:
  34     virtual ~static_permutation() {}
  35     /** Computes the i-th element of the permutation */
  36     virtual uint pi(uint i)=0;
  37     /** Computes the inverse of i */
  38     virtual uint rev_pi(uint i)=0;
  39     /** Saves the permutation to fp, returns 0 in case of success */
  40     virtual uint save(FILE *fp)=0;
  41     /** Returns the size of the permutation */
  42     virtual uint size()=0;
  43     /** Loads a static_permutation from fp */
  44     static static_permutation * load(FILE *fp);
  45 };
  46
  47 #include <static_permutation_mrrr.h>
  48
  49 #endif