sopt::Sampling Class Reference

An operator that samples a set of measurements. More...

#include <sampling.h>

Public Member Functions
	Sampling (t_uint size, std::vector< t_uint > const &indices)
	Constructs from a vector. More...
template<typename RNG >
	Sampling (t_uint size, t_uint samples, RNG &&rng)
	Constructs from the size and the number of samples to pick. More...
	Sampling (t_uint size, t_uint samples)
	Constructs from the size and the number of samples to pick. More...
template<typename T0 , typename T1 >
void	operator() (Eigen::DenseBase< T0 > &out, Eigen::DenseBase< T1 > const &x) const
template<typename T0 , typename T1 >
void	operator() (Eigen::DenseBase< T0 > &&out, Eigen::DenseBase< T1 > const &x) const
template<typename T0 , typename T1 >
void	adjoint (Eigen::DenseBase< T0 > &out, Eigen::DenseBase< T1 > const &x) const
template<typename T0 , typename T1 >
void	adjoint (Eigen::DenseBase< T0 > &&out, Eigen::DenseBase< T1 > const &x) const
t_uint	cols () const
	Size of the vector returned by the adjoint operation. More...
t_uint	rows () const
	Number of measurements. More...
std::vector< t_uint > const &	indices () const
	Indices of sampled points. More...

Detailed Description

An operator that samples a set of measurements.

Picks some elements from a vector

Definition at line 17 of file sampling.h.

Constructor & Destructor Documentation

Sampling() [1/3]

sopt::Sampling::Sampling ( t_uint  size, std::vector< t_uint > const &  indices  )

inline

Constructs from a vector.

Definition at line 20 of file sampling.h.

: indices_(indices), size(size) {}

Sampling() [2/3]

template<typename RNG >

sopt::Sampling::Sampling	(	t_uint	size,
		t_uint	samples,
		RNG &&	rng
	)

Constructs from the size and the number of samples to pick.

Definition at line 91 of file sampling.h.

                                                         : indices_(size), size(size) {
  std::iota(indices_.begin(), indices_.end(), 0);
  std::shuffle(indices_.begin(), indices_.end(), rng);
  indices_.resize(samples);
}

Sampling() [3/3]

sopt::Sampling::Sampling ( t_uint  size, t_uint  samples  )

inline

Constructs from the size and the number of samples to pick.

Definition at line 25 of file sampling.h.

      : Sampling(size, samples, std::mt19937_64(std::random_device()())) {}

Member Function Documentation

adjoint() [1/2]

template<typename T0 , typename T1 >

void sopt::Sampling::adjoint ( Eigen::DenseBase< T0 > &&  out, Eigen::DenseBase< T1 > const &  x  ) const

inline

Definition at line 41 of file sampling.h.

                                                                            {
    adjoint(out, x);
  }

References adjoint().

adjoint() [2/2]

template<typename T0 , typename T1 >

void sopt::Sampling::adjoint	(	Eigen::DenseBase< T0 > &	out,
		Eigen::DenseBase< T1 > const &	x
	)		const

Definition at line 70 of file sampling.h.

                                                                                 {
  assert(static_cast<t_uint>(x.size()) == indices_.size());
  out.resize(out.size());
  out.fill(0);
  for (decltype(indices_.size()) i(0); i < indices_.size(); ++i) {
    assert(indices_[i] < static_cast<t_uint>(out.size()));
    out[indices_[i]] = x[i];
  }
}

Referenced by adjoint(), and sopt::linear_transform().

cols()

t_uint sopt::Sampling::cols ( ) const

inline

Size of the vector returned by the adjoint operation.

Definition at line 46 of file sampling.h.

{ return size; }

Referenced by sopt::linear_transform().

indices()

std::vector<t_uint> const& sopt::Sampling::indices ( ) const

inline

Indices of sampled points.

Definition at line 51 of file sampling.h.

{ return indices_; }

Referenced by TEST_CASE().

operator()() [1/2]

template<typename T0 , typename T1 >

void sopt::Sampling::operator() ( Eigen::DenseBase< T0 > &&  out, Eigen::DenseBase< T1 > const &  x  ) const

inline

Definition at line 33 of file sampling.h.

                                                                               {
    operator()(out, x);
  }

References operator()().

operator()() [2/2]

template<typename T0 , typename T1 >

void sopt::Sampling::operator()	(	Eigen::DenseBase< T0 > &	out,
		Eigen::DenseBase< T1 > const &	x
	)		const

Definition at line 61 of file sampling.h.

                                                                                    {
  out.resize(indices_.size());
  for (decltype(indices_.size()) i(0); i < indices_.size(); ++i) {
    assert(indices_[i] < static_cast<t_uint>(x.size()));
    out[i] = x[indices_[i]];
  }
}

Referenced by operator()().

rows()

t_uint sopt::Sampling::rows ( ) const

inline

Number of measurements.

Definition at line 48 of file sampling.h.

{ return indices_.size(); }

Referenced by sopt::linear_transform().

---

The documentation for this class was generated from the following files:

• /home/runner/work/sopt/sopt/cpp/sopt/sampling.h
• /home/runner/work/sopt/sopt/cpp/sopt/sampling.cc