Note

Программа была протестирована на ядре Linux, под процессор семейства x86. На остальных системах тесты не проводились.

Квадратка

Скачивание программы

Для скачивания программы нужно ввести в консоль. Необходимо скачать git.

git clone https://github.com/demagogen/kvadratka.git
cd kvadratka

Сборка программы

Для сборки программы нужно скачать make

sudo [пакетный менеджер] make

после чего можно вписать для сборки программы

make

или

make docs

если нужна документация.

Чтобы удалить папки с обджект-файлами, html, нужно ввести

make clean

Запуск программы

Для запуска программы нужно ввести в консоль

./kvadratka/build/kvadratka

Выбор режима программы (флаги)

Существуют флаги:

1. -h --help
2. -V --version
3. -t --version
4. -s --solve

Флаги -h и --help

После ввода флагов

./kvadratka -h

или

./kvadratka --help

в консоли выведется

Использование: ./kvadratka [option]
При отсутствии флага запустится решение квадратного уравнения
                            -h, --help      помощь
                            -V, --version   версия
                            -t, --test      запуск тестов
                            -s, --solve     запуск решения квадратного уравнения

Версия программы

Чтобы посмотреть версию программы, можно ввести одну из двух команд

./kvadratka -V

./kvadratka --version

после чего выведится ваша версия программы

Версия 1.0.0 Poltorashka Edition

Режим тестирования программы

После ввода

./kvadratka -t

или

./kvadratka --test

запускаются тесты программы

Старт теста 1
тест 1 пройден
Старт теста 2
тест 2 пройден
Старт теста 3
тест 3 пройден
Старт теста 4
тест 4 пройден
Старт теста 5
тест 5 пройден
Старт теста 6
тест 6 пройден
Старт теста 7
тест 7 пройден
Старт теста 8
Ошибка в тесте 8
a = 0.100000, b = 0.100000, c = 0.600000, num_of_sol = TWO_SOLUTIONS, x1 = 2.000000, x2 = -3.000000
num_of_sol = NO_SOLUTIONS, x1 = nan, x2 = nan
Старт теста 9
тест 9 пройден

Ввод своих тестовых значений

Чтобы ввести свои тестовые значения, нужно открыть файл tests.cpp и внести изменения в уже имеющиеся тесты, или добавить новые в структуру test_data

static const TEST_DATA test_data_array[] {
    {
        .number_of_test = 1,
        .a = 0,
        .b = 0,
        .c = 0,
        .x1_ex = NAN,
        .x2_ex = NAN,
        .num_of_sol_ex = INF_NUMBER_OF_SOLUTIONS,
    },

Режим решения квадратного уравнения

Есть два возможных варианта запуска режима:

./kvadratka -s

./kvadratka --solve

также программа запустится, если не вводить никаких флагов

./kvadratka

После запуска нужно ввести три коэффициента через запятую

Введите значения трех коэффициентов через пробел!
228 1984 666

после чего программа выведет ответ

Два решения: -0.349742 -8.352012

Документация

Чтобы посмотреть документацию, нужно ввести в консоль команды

make docs
xdg-open ./html/index.html

Удаление программы

Чтобы удалить программу, нужно ввести в консоль команды

cd ../
rm -rf kvadratka