version.h

Go to the documentation of this file.

/*
    VERISON.H
    ---------
    Copyright (c) 2016-2017 Andrew Trotman
    Released under the 2-clause BSD license (See:https://en.wikipedia.org/wiki/BSD_licenses)
*/
#pragma once

#include <string>

namespace JASS
    {
    class version
        {
        public:
            static constexpr const char *version_string = "0.1";            
            static constexpr uint64_t version_BCD = 0x0001;         
            static constexpr size_t bitness = sizeof(void *) * 8;   
            #if defined(DEBUG) || defined(_DEBUG)
                #ifdef NDEBUG
                    #error "NDEBUG is defined in a DEBUG build - Can't proceed without knowing which is true"
                #else
                    static constexpr const char *debugness = "DEBUGGING-build ";        
                    static constexpr bool debug = true;                         
                #endif
            #else
                static constexpr const char *debugness = "";                    
                static constexpr bool debug = false;                            
            #endif

            /*
                VERSION::BUILD()
                ----------------
            */
            static std::string build(void)
                {
                return std::string("JASS Version ") + std::string(version_string) + std::string(" ") + std::to_string(bitness) + std::string("-bit ") + std::string(debugness) + std::string("Copyright (c) 2016-2019 Andrew Trotman, University of Otago");
                }

            /*
                VERSION::CREDITS()
                ------------------
            */
            static std::string credits(void)
                {
                return
                    build() + "\n"
                    "DESIGN & IMPLEMENTATION\n"
                    "-----------------------\n"
                    "Andrew Trotman\n"
                    "\n"

                    "SEARCH ENGINE\n"
                    "-------------\n"
                    "Andrew Trotman\n"
                    "\n"

                    "COMPRESSION CODE\n"
                    "----------------\n"
                    "Variable Byte    - Andrew Trotman\n"
                    "Stream VByte     - Daniel Lemire and Kendall Willets (Apache License Version 2.0, January 2004) https://github.com/lemire/streamvbyte\n"
                    "Simple-9         - Vikram Subramanya, Andrew Trotman, Blake Burgess\n"
                    "Simple-9 packed  - Vikram Subramanya, Andrew Trotman, Michael Albert, Blake Burgess\n"
                    "Simple-8b        - Blake Burgess, Andrew Trotman\n"
                    "Simple-8b packed - Blake Burgess, Andrew Trotman, Michael Albert\n"
                    "Simple-16        - Blake Burgess, Andrew Trotman\n"
                    "Simple-16 packed - Blake Burgess, Andrew Trotman, Michael Albert\n"
                    "Relative-10      - Vikram Subramanya, Andrew Trotman\n"
                    "Carryover-12     - Andrew Trotman\n"
                    "Carry-8b         - Andrew Trotman\n"
                    "QMX Original     - Andrew Trotman\n"
                    "QMX Improved     - Andrew Trotman\n"
                    "\n"

                    "OTHER STUFF\n"
                    "-----------\n"
                    "AVX512 Quicksort - Berenger Bramas (MIT licence)\n"
                    "";
                }
        };
    }