ConcurrentOperation.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: ConcurrentOperation
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/BaseValues.h>
#include "DLLInfo.h"
#include <mutex>
#include <future>
namespace NDEVR
{
    /**----------------------------------------------------------------------------
    \brief Contains thread-safe operations for inter-thread logic
    Increment and Decrement can be used to safely add to a shared uint04 value.
    Also contains sort, wait, and notify functions.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API ConcurrentOperation
    {
    public:
        static uint04 increment(volatile uint04& value);
        static uint04 decrement(volatile uint04& value);
        static void wait(void* object, std::unique_lock<std::mutex>& lock);
        static void wait(void* object, uint08 time, std::unique_lock<std::mutex>& lock);
        static void notify(void* object);
        static void notifyAll(void* object);
        template<class t_type, class t_function_type>
        static void ParallelSort(t_type* data, uint04 len, t_function_type function)
        {
            ParallelGrainSort(data, len, getMax(1024U, len / 16U), function);
        }
        template<class t_type, class t_function_type>
        static void ParallelGrainSort(t_type* data, uint04 len, uint04 grain_size, const t_function_type& function)
        {
            // Use grainsize instead of thread count so that we don't e.g.
            // spawn 4 threads just to sort 8 elements.
            if (len < grain_size)
            {
                std::sort(data, data + len, function);
            }
            else
            {
                auto future = std::async(ParallelGrainSort<t_type, t_function_type>, data, len / 2, grain_size, function);
 
                // No need to spawn another thread just to block the calling 
                // thread which would do nothing.
                ParallelGrainSort(data + len / 2, len - len / 2, grain_size, function);
 
                future.wait();
 
                std::inplace_merge(data, data + len / 2, data + len, function);
            }
        }
    };
}