Only test up to the sqrt.

The old policy caused issues because it's about to be lost in the newer
versions of CMake, so we'll have to deal with warnings from CMake until
the FindOpenMP.cmake file is updated.

.gitlab-ci.yml

@@ -1,20 +0,0 @@
-image: gcc
-
-build:
-    stage: build
-    # Install dependencies
-    before_script:
-        - apt update && apt -y install cmake libgmp-dev
-    # Build the project
-    script:
-        - cd build/
-        - cmake -DCMAKE_BUILD_TYPE=Release ..
-        - make
-    # Find the resulting binary
-    artifacts:
-        paths:
-            - build/indivisible
-    # Cache .o files for faster compiling
-    cache:
-        paths:
-            - "*.o"

AUTHORS.md

@@ -1,8 +0,0 @@
-Authors
-=======
-These are a list of people that have contributed to the Uhn project.
-
-| **Name/Alias**            | **E-Mail**                            |
-|---------------------------|---------------------------------------|
-| Deathsbreed               | deathsbreed@themusicinnoise.net       |
-

CHANGELOG

@@ -16,3 +16,27 @@ Change Log
   - Algorithm skips half the known primes.
   - Removed `likely()' and `unlikely()' macros due to lack of information.
   - Improved performance.
+ - v0.4: Fixed Algorithm
+  - Fixed algorithm to actually calculate primes.
+  - Added extra C99 optimizations.
+ - v0.5: Minor Changes
+  - Use `size_t' instead of `unsigned long long int'.
+  - Minor optimizations to the algorithm.
+  - Added commandline argument parsing.
+ - v0.6: User Control
+  - Allow user to choose base in which the prime numbers are printed.
+  - Give option for primes to be saved to a file upon exit.
+  - Free memory and leave instead of emergency exit.
+ - v0.7: Data Saving
+  - Allow user to save found primes to be loaded later.
+  - User can save and read primes in raw output.
+ - v1.0: Parallelization
+  - Now completely parallelized.
+  - Cleaned up/organized the code-base
+  - Exporting files uses less memory
+  - Allow searching for the nth prime number
+  - Clearing some memory leaks
+ - v2.0: Linked List
+  - Implement linked list for faster addition to list.
+  - Multi-Processor support (MPI).
+  - Code cleanup.

CMakeLists.txt

@@ -1,39 +1,66 @@
-cmake_minimum_required(VERSION 2.6)
-project(Indivisible)
+# Copyright (C) 2017  Ortega Froysa, Nicolás <deathsbreed@themusicinnoise.net>
+# Author: Ortega Froysa, Nicolás <deathsbreed@themusicinnoise.net>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-cmake_policy(SET CMP0012 OLD)
+cmake_minimum_required(VERSION 3.0)
+project(Indivisible C)
 
 set(TARGET_NAME indivisible)
+set(TARGET_VERSION "v2.0")
 
 if(NOT CMAKE_BUILD_TYPE)
-	set(CMAKE_BUILD_TYPE Debug)
+	set(CMAKE_BUILD_TYPE "release")
 endif()
+string(TOLOWER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE)
+message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
 set(CMAKE_MODULE_PATH
 	${CMAKE_MODULE_PATH}
 	${CMAKE_SOURCE_DIR}/cmake/)
 
 find_package(GMP REQUIRED)
+find_package(MPI REQUIRED)
 
 include_directories(
+	${MPI_C_INCLUDE_PATH}
 	${GMP_INCLUDE_DIR})
 
 set(SRCS
-	src/main.c
-	src/list.c)
+	"src/linked_list.c"
+	"src/main.c")
 
 # Define the C flags.
-set(CMAKE_C_FLAGS "-std=gnu99 -Wall -Wextra -Werror -Wfatal-errors -Wmissing-declarations -pedantic-errors")
-set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS} -g -O0")
-set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS} -O3")
-set(CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS} -g -O3")
-set(CMAKE_C_FLAGS_MINSIZEREL "${CMAKE_C_FLAGS} -Os")
+set(CMAKE_C_FLAGS "-std=gnu99 ${MPI_C_COMPILE_FLAGS} -Wall -Wextra -Werror -Wfatal-errors -Wmissing-declarations -pedantic-errors")
+set(CMAKE_C_FLAGS_DEBUG "-g -O0")
+set(CMAKE_C_FLAGS_RELEASE "-O3")
+set(CMAKE_C_FLAGS_RELWITHDEBINFO "-g -O3")
+set(CMAKE_C_FLAGS_MINSIZEREL "-Os")
 
-if(NOT CMAKE_BUILD_TYPE MATCHES Debug AND NOT CMAKE_BUILD_TYPE MATCHES RelWithDebInfo)
-	add_definitions(-DNDEBUG)
+if(NOT CMAKE_BUILD_TYPE MATCHES "debug" AND NOT CMAKE_BUILD_TYPE MATCHES "relwithdebinfo")
+	add_definitions("-DNDEBUG")
+else()
+	add_definitions("-DDEBUG")
 endif()
 
+add_definitions("-DVERSION=\"${TARGET_VERSION}\"")
+
 add_executable(${TARGET_NAME} ${SRCS})
 
 target_link_libraries(${TARGET_NAME}
+	${MPI_C_LIBRARIES}
 	${GMP_LIBRARY})
+
+install(TARGETS ${TARGET_NAME}
+	RUNTIME DESTINATION "bin")

CONTRIBUTING.md

@@ -1,23 +0,0 @@
-Contributing
-============
-We gladly accept contributions to Indivisible, however there are a few guidelines that must be followed.
-
-1) Copyright & Licensing
-------------------------
-The copyright of this project and all of its code, unless stated otherwise, belongs to Nicolás Ortega and is licensed with the [GNU GPLv3](/LICENSE). This also applies to all contributions (contributors may add themselves to the [authors file](/AUTHORS.md) for recognition). This is purely for legal purposes, there is no intention to deny your contributions.
-
-2) Documentation
-----------------
-All new features added must be well documented using DOxygen style comments. If your merge request adds a new feature and it is not well documented we will ask you to finish documenting the code before accepting a merge. This is simply so that both the maintainers of this repo and other users can understand the new API that bas been added.
-
-3) Code-Style
--------------
-The only aspects that will be religiously upheld for all contributions to this repo are indentation and bracket placement. All indentation must be tab characters (reason being so that everyone can view the code with the indentation that they prefer rather than being forced to see a specific indentation), and brackets must be attached. Everything else is minor and can be overlooked.
-
-Things that would be nice is if you could avoid having the lines being too long, and please avoid having more than one empty line in a row.
-
-4) Fractured Merge Requests
----------------------------
-Please make sure your merge requests are fractured into separate parts so that it may be easy for us to deal with them individually. The reason for this is to avoid having merge requests that both fix bugs and add features when in reality they should be separate requests. The only exception to this will be if the changes made to the code depend on one another to function properly.
-
-If your merge request meets all these requirements and is passed by one of the moderators it will be merged into the main repo.

README

@@ -0,0 +1,32 @@
+===================
+*** Indivisible ***
+===================
+Indivisible is a parallelized prime number generator written in C.
+
+# Building
+----------
+There are multiple dependencies to install before compiling the project:
+
+ - CMake build system
+ - GNU Multi-Precision Arithmetics Library
+
+Once the dependencies are installed you can compile by running the following
+from the root directory of the project:
+
+  cd build/
+  cmake ..
+  make
+
+This will create a release build, to build with debug options append the
+`-DCMAKE_BUILD_TYPE=debug' flag to the `cmake' command.
+
+# Contributing
+--------------
+To contribute to indivisible you can send patch files to my e-mail[0].
+
+[0] nortega@themusicinnoise.net
+
+# License
+---------
+This project is licensed under the GNU General Public License version 3 or
+greater (see `LICENSE' for more information).

README.md

@@ -1,28 +0,0 @@
-Indivisible
-===========
-[![build status](https://gitlab.com/Deathsbreed/Indivisible/badges/master/build.svg)](https://gitlab.com/Deathsbreed/Indivisible/commits/master)
-
-Indivisible is an optimized prime number generator written in C.
-
-Building
---------
-There are multiple dependencies to install before compiling the project:
-- CMake
-- GMP
-
-Once the dependencies are installed you can compile by running the following from the root directory of the project:
-```bash
-$ cd build/
-$ cmake ..
-$ make
-```
-
-To build a release build run `cmake -DCMAKE_BUILD_TYPE=Release ..` instead.
-
-Contributing
-------------
-If you would like to contribute to Uhn then please read the [contributing file](/CONTRIBUTING.md) before creating a merge request.
-
-License
--------
-This project is licensed with the [GNU GPLv3](/LICENSE). Since it is an educational project I find it very important that all contributions continue to remain free/libre.

TODO.md

@@ -1,15 +0,0 @@
-To-Do
-=====
-A to-do list for the project. Feel free to remove items as you solve them in your pull requests.
-
-Next
-----
-To-do items to do for the next version:
-
-- Profile code to better use `likely()` and `unlikely()` macros.
-
-Features
---------
-Features for future versions (not _Next_) of Indivisible:
-
-- Implement multi-threaded version using OpenCL or OpenMP (whichever works).

astyle.cfg

@@ -1,3 +0,0 @@
---lineend=linux
---indent=tab
---style=attach

src/global.h

@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2018  Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ * Author: Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#ifndef VERSION
+#	define VERSION "version"
+#endif
+
+/* argp variables */
+const char *argp_program_version = VERSION;
+const char *argp_program_bug_address = "<nortega@themusicinnoise.net>";
+
+/* argp options */
+static char desc[] = "A parallelized prime number generator.";
+/*static char args_doc[] = "--count=<number> [--verbose]";*/
+static struct argp_option opts[] = {
+	{ "count", 'c', "number", 0, "The number of primes to generate (default is 1000)", 0},
+	{ "verbose", 'v', 0, 0, "Print out discovered primes", 0 },
+	{ 0 }
+};
+
+struct args {
+	size_t count;
+	int verbose;
+};
+
+static error_t parse_opt(int key, char *arg, struct argp_state *state) {
+	struct args *args = state->input;
+	switch(key)
+	{
+		case 'c':
+			args->count = (size_t)atol(arg);
+			break;
+		case 'v':
+			args->verbose = 1;
+			break;
+		case ARGP_KEY_ARG:
+			return 0;
+		default:
+			return ARGP_ERR_UNKNOWN;
+	}
+	return 0;
+}
+
+static struct argp argp = { opts, parse_opt, 0, desc, 0, 0, 0 };

src/linked_list.c

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2018  Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ * Author: Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "linked_list.h"
+
+#include <stdlib.h>
+
+void llist_init(struct llist *list) {
+	list->size = 0;
+	list->first = NULL;
+	list->last = NULL;
+}
+
+int llist_add(struct llist *list, mpz_t num) {
+	struct llist_item *item =
+		malloc(sizeof(struct llist_item));
+	if(!item)
+		return 0;
+
+	mpz_init(item->num);
+	mpz_set(item->num, num);
+
+	if(!(list->first))
+	{
+		list->first = item;
+		list->last = item;
+	}
+	else
+	{
+		list->last->next = item;
+		list->last = item;
+	}
+	list->size++;
+
+	return 1;
+}
+
+void llist_deinit(struct llist *list) {
+	struct llist_item *i = list->first;
+
+	while(i)
+	{
+		mpz_clear(i->num);
+		struct llist_item *next = i->next;
+		free(i);
+		i = next;
+	}
+
+	list->size = 0;
+}

src/linked_list.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2018  Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ * Author: Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <gmp.h>
+
+struct llist_item {
+	mpz_t num;
+	struct llist_item *prev;
+	struct llist_item *next;
+};
+
+struct llist {
+	struct llist_item *first;
+	struct llist_item *last;
+	size_t size;  // size of the list
+};
+
+void llist_init(struct llist *list);
+int llist_add(struct llist *list, mpz_t num);
+void llist_deinit(struct llist *list);

src/list.c

@@ -1,44 +0,0 @@
-#include "list.h"
-#include <stdlib.h>
-#include <stdio.h>
-
-/**
- * This is the number of elements by which the list expands.
- * WARNING: Always use doubles for this number (2^X)
- */
-#define BLOCK_SIZE 1024
-
-void initList(List *l) {
-	l->list = malloc(sizeof(mpz_t) * BLOCK_SIZE);
-	if(!l->list) {
-		fprintf(stderr, "Failed to allocate memory to list!\n");
-		exit(1);
-	}
-	l->size = BLOCK_SIZE;
-	l->end = 0;
-}
-
-void deInitList(List *l) {
-	for(ulli i = 0; i < l->size; ++i) {
-		mpz_clear(l->list[i]);
-	}
-	free(l->list);
-}
-
-void addToList(List *l, mpz_t n) {
-	if(l->end == l->size) {
-		l->size += BLOCK_SIZE;
-		if(l->size == 0) {
-			fprintf(stderr, "`l->size' has overflowed!\n");
-			exit(1);
-		}
-		void *tmp = realloc(l->list, sizeof(mpz_t) * l->size);
-		if(!tmp) {
-			fprintf(stderr, "Failed to allocate more memory to list!\n");
-			exit(1);
-		}
-		l->list = (mpz_t*)tmp;
-	}
-	mpz_init(l->list[l->end]);
-	mpz_set(l->list[l->end++], n);
-}

src/list.h

@@ -1,38 +0,0 @@
-#pragma once
-#include <gmp.h>
-#include <stdbool.h>
-
-#include "types.h"
-
-/**
- * @brief An infinitely expanding list type.
- */
-typedef struct {
-	mpz_t *list; //!< The list of elements
-	ulli size; //!< How many elements are in the list
-	ulli end; //!< The last element of the list (in use)
-} List;
-
-/**
- * @brief Initialize a List.
- * @details Initialize the list and its variables, allocating memory
- * to the pointer array inside. Returns true on success and false on
- * failure.
- * @param[in] l A pointer to a List type to be initialized.
- */
-void initList(List *l);
-
-/**
- * @brief Deinitialize a List.
- * @details Release all memory that has been allocated to the list.
- * @param[in] l A pointer to a List type to be deinitialized.
- */
-void deInitList(List *l);
-
-/**
- * @brief Adds a new item to a List type.
- * @details Add item `n' at the end of a List type.
- * @param[out] l List to which the variable should be appended.
- * @param[in] n variable to be appended to the list.
- */
-void addToList(List *l, mpz_t n);

src/main.c

@@ -1,77 +1,90 @@
+/*
+ * Copyright (C) 2018  Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ * Author: Ortega Froysa, Nicolás <nortega@themusicinnoise.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
-#include <signal.h>
-#include <stdbool.h>
+#include <argp.h>
 #include <gmp.h>
 
-#include "list.h"
-#include "types.h"
+#include "global.h"
+#include "linked_list.h"
 
-static bool run;
-void leave();
+int main(int argc, char *argv[]) {
+	struct args args = { 1000, 0 };
 
-int main(void) {
-	puts("Indivisible v0.2\n");
+	argp_parse(&argp, argc, argv, 0, 0, &args);
 
-	// Quit on ^C by setting `run = false'
-	run = true;
-	signal(SIGINT, leave);
-
-	// Primes we've found
-	List primes;
-	initList(&primes);
-
-	// The number we're going to be testing for
-	mpz_t num;
-	mpz_init(num);
-
-	// Add 2, a known prime to this list
-	mpz_set_ui(num, 2);
-	addToList(&primes, num);
-	if(mpz_out_str(stdout, 10, num) == 0) {
-		fprintf(stderr, "Could not print to `stdout'!\n");
-		exit(1);
+	if(args.count == 0)
+	{
+		fprintf(stderr, "ERROR: count must be larger than 0.\n");
+		return 1;
 	}
+
+	struct llist prime_list;
+	llist_init(&prime_list);
+
+	{
+		// initialize the list with 2
+		mpz_t tmp;
+		mpz_init(tmp);
+		mpz_set_ui(tmp, 2);
+		llist_add(&prime_list, tmp);
+		mpz_clear(tmp);
+		if(args.verbose)
+			puts("2");
+	}
+
+	mpz_t aux;
+	mpz_init(aux);
+	mpz_set_ui(aux, 3);
+	while(prime_list.size < args.count)
+	{
+		struct llist_item *item = prime_list.first;
+		int is_prime = 1;
+
+		mpz_t root;
+		mpz_init(root);
+		mpz_sqrt(root, aux);
+		while(item && mpz_cmp(item->num, root) < 0)
+		{
+			if(mpz_divisible_p(aux, item->num))
+			{
+				is_prime = 0;
+				break;
+			}
+			item = item->next;
+		}
+		if(is_prime)
+		{
+			llist_add(&prime_list, aux);
+			if(args.verbose)
+			{
+				mpz_out_str(stdout, 10, aux);
 				printf("\n");
-	mpz_add_ui(num, num, 1);
-
-	// Variable for half `num'
-	mpz_t halfNum;
-	mpz_init(halfNum);
-
-	do {
-		// Calculate half of `num'
-		mpz_fdiv_q_ui(halfNum, num, 2);
-		// Loop through found primes
-		// Skip 2 because we're skipping even nymbers
-		for(ulli i = 1; mpz_cmp(primes.list[i], halfNum) >= 0; ++i) {
-			// If `num' is divisible by a prime then go to the next number
-			if(mpz_divisible_p(num, primes.list[i]) != 0)
-				goto nextPrime;
+			}
+		}
+		mpz_add_ui(aux, aux, 2);
 	}
 
-		// `num' is a prime so we add it to the list and print it
-		addToList(&primes, num);
-		if(mpz_out_str(stdout, 10, num) == 0) {
-			fprintf(stderr, "Could not print to `stdout'!\n");
-			exit(1);
-		}
+	printf("The %zu prime is ", prime_list.size);
+	mpz_out_str(stdout, 10, prime_list.last->num);
 	printf("\n");
 
-nextPrime:
-		// Add 2 (skip even numbers since they're all divisible by 2)
-		mpz_add_ui(num, num, 2);
-	} while(run);
-
-	// Clear GMP variables
-	mpz_clear(halfNum);
-	mpz_clear(num);
-	// Deinitialize the list
-	deInitList(&primes);
+	llist_deinit(&prime_list);
 	return 0;
 }
-
-void leave() {
-	puts("Exiting...\n");
-	run = false;
-}

src/types.h

@@ -1,2 +0,0 @@
-#pragma once
-typedef unsigned long long int ulli;