factoring_machine.h

Go to the documentation of this file.

// Copyright (C) 2011 CNRS - Ecole Polytechnique - INRIA.
//
// This file is part of TIFA.
//
// TIFA is free software; you can redistribute it and/or modify it under the 
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your option)
// any later version.
//
// TIFA 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 Lesser General Public License for
// more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.

#if !defined(_TIFA_FACTORING_MACHINE_H_)

#define _TIFA_FACTORING_MACHINE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <gmp.h>

#include "array.h"
#include "exit_codes.h"

enum factoring_mode_enum {
    SINGLE_RUN,
    FIND_SOME_FACTORS,
    FIND_SOME_COPRIME_FACTORS,
    FIND_SOME_PRIME_FACTORS,
    FIND_COMPLETE_FACTORIZATION
};
typedef enum factoring_mode_enum factoring_mode_t;

static const int mode_to_outcome[5] = {
    SOME_FACTORS_FOUND,
    SOME_FACTORS_FOUND,
    SOME_COPRIME_FACTORS_FOUND,
    SOME_PRIME_FACTORS_FOUND,
    COMPLETE_FACTORIZATION_FOUND
};

struct struct_factoring_machine {
    mpz_t n;
    factoring_mode_t mode;
    void* context;
    void* params;
    ecode_t (*init_context_func)   (struct struct_factoring_machine* const);
    ecode_t (*perform_algo_func)   (struct struct_factoring_machine* const);
    ecode_t (*update_context_func) (struct struct_factoring_machine* const);
    ecode_t (*clear_context_func)  (struct struct_factoring_machine* const);
    ecode_t (*recurse_func) (mpz_array_t* const,
                             uint32_array_t* const,
                             const mpz_t,
                             factoring_mode_t);
    mpz_array_t* factors;
    uint32_array_t* multis;
    bool success;
};
typedef struct struct_factoring_machine factoring_machine_t;

ecode_t run_machine(factoring_machine_t* machine);

#ifdef __cplusplus
}
#endif

#endif

---