Commit 10b7d7653238451f3d450350033f90d960932fb1

Authored by Jim Plank
1 parent b0e2ae07
Exists in master and in 3 other branches v1, v2, v3

Added headers to the include files, and gf_size() to the documentation.

Manual.pdf
No preview for this file type
gf_complete.h
1   -/* gf_complete.h
2   - * External include file for Galois field arithmetic. */
  1 +/*
  2 + * GF-Complete: A Comprehensive Open Source Library for Galois Field Arithmetic
  3 + * James S. Plank, Ethan L. Miller, Kevin M. Greenan,
  4 + * Benjamin A. Arnold, John A. Burnum, Adam W. Disney, Allen C. McBride.
  5 + *
  6 + * gf_complete.h
  7 + *
  8 + * The main include file for gf_complete.
  9 + */
3 10  
4 11 #pragma once
5 12 #include <stdint.h>
... ...
gf_general.h
1 1 /*
  2 + * GF-Complete: A Comprehensive Open Source Library for Galois Field Arithmetic
  3 + * James S. Plank, Ethan L. Miller, Kevin M. Greenan,
  4 + * Benjamin A. Arnold, John A. Burnum, Adam W. Disney, Allen C. McBride.
  5 + *
2 6 * gf_general.h
3 7 *
4 8 * This file has helper routines for doing basic GF operations with any
... ...
gf_int.h
1 1 /*
  2 + * GF-Complete: A Comprehensive Open Source Library for Galois Field Arithmetic
  3 + * James S. Plank, Ethan L. Miller, Kevin M. Greenan,
  4 + * Benjamin A. Arnold, John A. Burnum, Adam W. Disney, Allen C. McBride.
  5 + *
2 6 * gf_int.h
3 7 *
4   - * Internal code for Galois field routines.
  8 + * Internal code for Galois field routines. This is not meant for
  9 + * users to include, but for the internal GF files to use.
5 10 */
6 11  
7 12 #pragma once
... ...
gf_method.h
1 1 /*
  2 + * GF-Complete: A Comprehensive Open Source Library for Galois Field Arithmetic
  3 + * James S. Plank, Ethan L. Miller, Kevin M. Greenan,
  4 + * Benjamin A. Arnold, John A. Burnum, Adam W. Disney, Allen C. McBride.
  5 + *
2 6 * gf_method.h
3 7 *
4 8 * Parses argv to figure out the flags and arguments. Creates the gf.
... ...
gf_rand.h
1   -/* gf_rand.h
2   - * External include file for random number generation. */
  1 +/*
  2 + * GF-Complete: A Comprehensive Open Source Library for Galois Field Arithmetic
  3 + * James S. Plank, Ethan L. Miller, Kevin M. Greenan,
  4 + * Benjamin A. Arnold, John A. Burnum, Adam W. Disney, Allen C. McBride.
  5 + *
  6 + * gf_rand.h
  7 + *
  8 + * Random number generation, using the "Mother of All" random number generator. */
3 9  
4 10 #pragma once
5 11 #include <stdint.h>
... ...