checksum.h

Go to the documentation of this file.

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

#include <stdint.h>

#include <string>

namespace JASS
    {
    /*
        CLASS CHECKSUM
        --------------
    */
    class checksum
        {
        public:
            /*
                CHECKSUM::FLETCHER_16()
                -----------------------
            */
            template <typename TYPE>
            static uint16_t fletcher_16(TYPE &start, TYPE &end);


            /*
                CHECKSUM::FLETCHER_16()
                -----------------------
            */
            static uint16_t fletcher_16(const void *data, size_t length);
    
            /*
                CHECKSUM::FLETCHER_16()
                -----------------------
            */
            static uint16_t fletcher_16(const std::string &string)
                {
                return fletcher_16(string.c_str(), string.length());
                }

            /*
                CHECKSUM::FLETCHER_16()
                -----------------------
            */
            static uint16_t fletcher_16(std::istream &stream);

            /*
                CHECKSUM::FLETCHER_16_FILE()
                ----------------------------
            */
            static uint16_t fletcher_16_file(const std::string &filename);

            /*
                CHECKSUM::UNITTEST()
                --------------------
            */
            static void unittest(void);
        };

    }