math/gfx-sqr.c: Use bithacking rather than a table for squaring.

[catacomb] / math / gfx-sqr.c

/* -*-c-*-
 *
 * Sqaring binary polynomials
 *
 * (c) 2000 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of Catacomb.
 *
 * Catacomb is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * Catacomb is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with Catacomb; if not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

/*----- Header files ------------------------------------------------------*/

#include "mpx.h"
#include "gfx.h"
#include "permute.h"

/*----- Main code ---------------------------------------------------------*/

/* --- @gfx_sqr@ --- *
 *
 * Arguments:	@mpw *dv, *dvl@ = destination vector base and limit
 *		@const mpw *av, *avl@ = argument vector base and limit
 *
 * Returns:	---
 *
 * Use:		Performs squaring of binary polynomials.
 */

void gfx_sqr(mpw *dv, mpw *dvl, const mpw *av, const mpw *avl)
{
#if MPW_BITS <= 16
#  define REGWD 16
#elif MPW_BITS <= 32
#  define REGWD 32
#elif MPW_BITS <= 64
#  define REGWD 64
#elif MPW_BITS <= 128
#  define REGWD 128
#else
#  error "unsupported limb width: extend `gfx-sqr.c'"
#endif

#if MPW_BITS == REGWD
  typedef mpw regty;
#else
  typedef mpd regty;
#endif

  regty a, t;

  /* --- Simple stuff --- */

  if (dv >= dvl)
    return;
  MPX_SHRINK(av, avl);

  /* --- The main algorithm --- *
   *
   * Our method depends on the fact that, in a field of characteristic 2, we
   * have that %$(a + b)^2 = a^2 + b^2$%.  Thus, to square a polynomial, it's
   * sufficient just to put a zero bit between each of the bits of the
   * original argument.
   */

  while (av < avl) {
    a = *av++;
					/* ..., 7, 6, 5, 4, 3, 2, 1, 0 */
    SWIZZLE_EXCH(a, 0, 1);		/* ..., 7, 6, 5, 4, 3, 2, 0, 1 */
    SWIZZLE_EXCH(a, 0, 2);		/* ..., 7, 6, 5, 4, 3, 1, 0, 2 */
    SWIZZLE_EXCH(a, 0, 3);		/* ..., 7, 6, 5, 4, 2, 1, 0, 3 */
#if MPW_BITS > 16
    SWIZZLE_EXCH(a, 0, 4);		/* ..., 7, 6, 5, 3, 2, 1, 0, 4 */
#endif
#if MPW_BITS > 32
    SWIZZLE_EXCH(a, 0, 5);		/* ..., 7, 6, 4, 3, 2, 1, 0, 5 */
#endif
#if MPW_BITS > 64
    SWIZZLE_EXCH(a, 0, 6);		/* ..., 7, 5, 4, 3, 2, 1, 0, 6 */
#endif
#if MPW_BITS > 128
#  error "unsupported limb width: extend `gfx-sqr.c'"
#endif

    /* Write out the low half, which consists of the low-order bits in
     * even-numbered positions.
     */
    *dv++ = MPW(a&IXMASK(0)); if (dv >= dvl) break;

    /* Write the high half.  This is trickier, since, in general, the bits
     * are split across even-numbered bits in the high part of the wider
     * register and odd-numbered bits in the low part.  Alas, we can't
     * resolve this mess without special cases because shifts are broken in
     * C.
     */
    t = ((a >> 1)&IXMASK(0)) << (REGWD - MPW_BITS);
#if MPW_BITS < REGWD
    t |= (a&IXMASK(0)) >> MPW_BITS;
#endif
    *dv++ = MPW(t); if (dv >= dvl) break;
  }

  /* --- Zero the rest of everything --- */

  MPX_ZERO(dv, dvl);

#undef REGWD
}

/*----- Test rig ----------------------------------------------------------*/

#ifdef TEST_RIG

#include <mLib/alloc.h>
#include <mLib/dstr.h>
#include <mLib/quis.h>
#include <mLib/testrig.h>

#define ALLOC(v, vl, sz) do {						\
  size_t _sz = (sz);							\
  mpw *_vv = xmalloc(MPWS(_sz));					\
  mpw *_vvl = _vv + _sz;						\
  (v) = _vv;								\
  (vl) = _vvl;								\
} while (0)

#define LOAD(v, vl, d) do {						\
  const dstr *_d = (d);							\
  mpw *_v, *_vl;							\
  ALLOC(_v, _vl, MPW_RQ(_d->len));					\
  mpx_loadb(_v, _vl, _d->buf, _d->len);					\
  (v) = _v;								\
  (vl) = _vl;								\
} while (0)

#define MAX(x, y) ((x) > (y) ? (x) : (y))

static void dumpmp(const char *msg, const mpw *v, const mpw *vl)
{
  fputs(msg, stderr);
  MPX_SHRINK(v, vl);
  while (v < vl)
    fprintf(stderr, " %08lx", (unsigned long)*--vl);
  fputc('\n', stderr);
}

static int vsqr(dstr *v)
{
  mpw *a, *al;
  mpw *b, *bl;
  mpw *d, *dl;
  int ok = 1;

  LOAD(a, al, &v[0]);
  LOAD(b, bl, &v[1]);
  ALLOC(d, dl, 2 * (al - a));

  gfx_sqr(d, dl, a, al);
  if (!mpx_ueq(d, dl, b, bl)) {
    fprintf(stderr, "\n*** vsqr failed\n");
    dumpmp("	   a", a, al);
    dumpmp("expected", b, bl);
    dumpmp("  result", d, dl);
    ok = 0;
  }

  xfree(a); xfree(b); xfree(d);
  return (ok);
}

static test_chunk defs[] = {
  { "sqr", vsqr, { &type_hex, &type_hex, 0 } },
  { 0, 0, { 0 } }
};

int main(int argc, char *argv[])
{
  test_run(argc, argv, defs, SRCDIR"/t/gfx");
  return (0);
}

#endif

/*----- That's all, folks -------------------------------------------------*/