InvJac Project

Overview

The InvJac project tests a hypothesis concerning the sum of the reciprocals of the Jacobian of polynomial maps. It verifies contractions and generates points with a unit Jacobian.

Dependencies

• GiNaC: C++ library for symbolic calculations.
• Glog: C++ logging library.
• Boost: Program options parsing.
• MySQL Connector/C++: MySQL database connector for C++.
• PHCpack: Solves polynomial systems by homotopy continuation. Note: Using a forked version with fixes: PHCpack fork

Building the Project

Ensure dependencies are installed. Use CMake to configure and build:

1. Create a build directory:

   mkdir build
   cd build

2. Run CMake:

   cmake ..

3. Build:

   make

Running the Application

Running Locally

After building, run the application:

./invjac

Running via Docker

Run the application using Docker:

docker run --pull always --rm --name invjac -i nook0110/invjac:prog

To use local MySQL, run with extra keys:

docker run --pull always --rm --name invjac -i nook0110/invjac:prog -d --db-host host.docker.internal

Usage

Command Line Options

• -h, --help: Display help.
• -i, --input-file: Specify input file.
• -d, --use-database: Use MySQL database.
• --db-host: Database host.
• --db-user: Database user.
• --db-password: Database password.
• --db-name: Database name.
• --results-table: Results table name.
• --passed-table: Passed results table name.
• --failed-table: Failed results table name.
• --error-table: Error results table name.

MySQL Database Setup

Create necessary tables with this SQL script:

-- Main table for all test resultsCREATETABLEtest_results (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
result_type ENUM('Passed', 'Failed', 'Error', 'Contraction') NOT NULL,
run_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
) ENGINE=InnoDB;
-- Table for Passed resultsCREATETABLEpassed_results (
result_id INTPRIMARY KEY,
amount_of_tests INT UNSIGNED NOT NULL,
FOREIGN KEY (result_id) REFERENCES test_results(id) ON DELETE CASCADE
) ENGINE=InnoDB;
-- Table for Failed resultsCREATETABLEfailed_results (
result_id INTPRIMARY KEY,
test TEXTNOT NULL,
result TEXTNOT NULL,
FOREIGN KEY (result_id) REFERENCES test_results(id) ON DELETE CASCADE
) ENGINE=InnoDB;
-- Table for Error resultsCREATETABLEerror_results (
result_id INTPRIMARY KEY,
error TEXTNOT NULL,
FOREIGN KEY (result_id) REFERENCES test_results(id) ON DELETE CASCADE
) ENGINE=InnoDB;
-- Table for Contraction resultsCREATETABLEcontraction_results (
result_id INTPRIMARY KEY,
contraction_point TEXTNOT NULL,
FOREIGN KEY (result_id) REFERENCES test_results(id) ON DELETE CASCADE
) ENGINE=InnoDB;

Example

Run the application with an input file and database:

./invjac -i input.txt -d --db-host localhost --db-user root --db-password root --db-name checked_functions

Documentation

For detailed documentation, visit: InvJac Documentation

Contributing

Contributions are welcome. Fork the repository and submit pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.