//------------------------------------------------------------------------------
// <copyright file="LqrSMACFletcherSum.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
//   Declaration of FletcherSum methods, which iterate over a collection and
//	 calculate a two-byte pair.  The first byte is a simple sum of the bytes
//	 and the second is a sum of the sums.  The algorithm is documented here:
//   http://en.wikipedia.org/wiki/Fletcher%27s_checksum
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __LQRSMACFLETCHERSUM_H__
#define __LQRSMACFLETCHERSUM_H__

#include <stdint.h>
#include <utility>
#include "LqrSMACByteArray.h"
#include "LqrSMACSharedLib.h"

namespace LiquidRobotics {
namespace SMACFramework {

SHARED_LIB_PUBLIC std::pair<uint8_t,uint8_t> FletcherSum(LiquidRobotics::SMACFramework::ByteArray::const_iterator ciStart, LiquidRobotics::SMACFramework::ByteArray::const_iterator ciEnd);

template<typename T>
std::pair<uint8_t,uint8_t> FletcherSum(const T& container)
{
	return FletcherSum(container.begin(), container.end());
}

}
}

#endif
