vpUniRand.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
 *
 * This software 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 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Pseudo random number generator.
 */
/*
 * PCG Random Number Generation for C.
 *
 * Copyright 2014 Melissa O'Neill <oneill@pcg-random.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For additional information about the PCG random number generation scheme,
 * including its license and other licensing options, visit
 *
 *     http://www.pcg-random.org
 */
 
/*
 * This code is derived from the full C implementation, which is in turn
 * derived from the canonical C++ PCG implementation. The C++ version
 * has many additional features and is preferable if you can use C++ in
 * your project.
 */
 
#ifndef _vpUniRand_h_
#define _vpUniRand_h_
 
#include <visp3/core/vpConfig.h>
// Visual Studio 2010 or previous is missing inttypes.h
#if defined(_MSC_VER) && (_MSC_VER < 1700)
typedef unsigned __int64 uint64_t;
typedef unsigned __int32 uint32_t;
#else
#include <inttypes.h>
#endif
 
#if (VISP_CXX_STANDARD <= VISP_CXX_STANDARD_11)
#include <algorithm> // std::random_shuffle
#else
#include <algorithm> // std::shuffle
#include <random>    // std::mt19937
#include <numeric>   // std::iota
#endif
 
#include <vector>
class VISP_EXPORT vpUniRand
{
private:
  struct vpPcgStateSetseq_64_t
  { // Internals are *Private*.
    uint64_t state;            // RNG state.  All values are possible.
    uint64_t inc;              // Controls which RNG sequence (stream) is
                               // selected. Must *always* be odd.
 
    vpPcgStateSetseq_64_t(uint64_t state_ = 0x853c49e6748fea9bULL, uint64_t inc_ = 0xda3e39cb94b95bdbULL)
      : state(state_), inc(inc_)
    { }
  };
  typedef struct vpPcgStateSetseq_64_t pcg32_random_t;
 
public:
  vpUniRand();
  vpUniRand(uint64_t seed, uint64_t seq = 0x123465789ULL);
 
  double operator()();
 
  uint32_t next();
  int uniform(int a, int b);
  float uniform(float a, float b);
  double uniform(double a, double b);
  void setSeed(uint64_t initstate, uint64_t initseq);
 
  template<typename T>
  inline static std::vector<T> shuffleVector(const std::vector<T> &inputVector)
  {
    std::vector<T> shuffled = inputVector;
#if (VISP_CXX_STANDARD <= VISP_CXX_STANDARD_11)
    std::random_shuffle(shuffled.begin(), shuffled.end());
#else
    std::shuffle(shuffled.begin(), shuffled.end(), std::mt19937 { std::random_device{}() });
#endif
    return shuffled;
  }
 
private:
  uint32_t boundedRand(uint32_t bound);
 
  double m_maxInvDbl;
  float m_maxInvFlt;
  pcg32_random_t m_rng;
};
 
#endif