C++ library¶

The C++ interface of Bohrium is similar to NumPy but is still very basic.

Indexing / Slicing¶

Bohrium C++ only support single index indexing:

// Create a new empty array (4 by 5)
bhxx::BhArray<double> A = bhxx::empty<double>({4, 5});
// Create view of the third row of A
bhxx::BhArray<double> B = A[2];

If you need more flexible slicing, you can set the shape and stride manually:

// Create a new array (4 by 5) of ones
bhxx::BhArray<double> A = bhxx::ones<double>({4, 5});
// Create view of the complete A.
bhxx::BhArray<double> B = A;
// B is now a 2 by 5 view with a step of two in the first dimension.
// In NumPy, this corresponds to: `B = A[::2, :]`
B.setShapeAndStride({2, 5}, {10, 1});

Code Snippets¶

You can find some examples in the source tree and some code snippets here:

#include<bhxx/bhxx.hpp>

/** Return a new empty array */
bhxx::BhArray<double> A = bhxx::empty<double>({4, 5});

/** Return the rank (number of dimensions) of the array */
int rank = A.rank();

/** Return the offset of the array */
uint64_t offset = A.offset();

/** Return the shape of the array */
Shape shape = A.shape();

/** Return the stride of the array */
Stride stride = A.stride();

/** Return the total number of elements of the array */
uint64_t size = A.size();

/** Return a pointer to the base of the array */
std::shared_ptr<BhBase> base = A.base();

/** Return whether the view is contiguous and row-major */
bool is_contig = A.isContiguous();

/** Return a new copy of the array */
bhxx::BhArray<double> copy = A.copy();

/** Return a copy of the array as a standard vector */
std::vector<double> vec = A.vec();

/** Print the content of A */
std::cout << A << "\n";

// Return a new transposed view
bhxx::BhArray<double> A_T = A.transpose();

// Return a new reshaped view (the array must be contiguous)
bhxx::BhArray<double> A_reshaped = A.reshape(Shape shape);

/** Return a new view with a "new axis" inserted.
 *
 *  The "new axis" is inserted just before `axis`.
 *  If negative, the count is backwards
 */
bhxx::BhArray<double> A_new_axis = A.newAxis(1);

// Return a new empty array
auto A = bhxx::empty<float>({3,4});

// Return a new empty array that has the same shape as `ary`
auto B = bhxx::empty_like<float>(A);

// Return a new array filled with zeros
auto A = bhxx::zeros<float>({3,4});

// Return evenly spaced values within a given interval.
auto A = bhxx::arange(1, 3, 2); // start, stop, step
auto A = bhxx::arange(1, 3); // start, stop, step=1
auto A = bhxx::arange(3); // start=0, stop, step=1

// Random array, interval [0.0, 1.0)
auto A = bhxx::random.randn<double>({3, 4});

// Element-wise `static_cast`.
bhxx::BhArray<int> B = bhxx::cast<int>(A);

// Alias, A and B points to the same underlying data.
bhxx::empty<float> A = bhxx::empty<float>({3,4});
bhxx::empty<float> B = A;

// a is an alias
void add_inplace(bhxx::BhArray<double> a,
                 bhxx::BhArray<double> b) {
    a += b;
}
add_inplace(A, B);

// Create the data of A into a new array B.
bhxx::empty<float> A = bhxx::empty<float>({3,4});
bhxx::empty<float> B = A.copy();

// Copy the data of B into the existing array A.
A = B;

// Copying and converting the data of A into C.
bhxx::empty<double> C = bhxx::cast<double>(A);

// Alias, A and B points to the same underlying data.
bhxx::empty<float> A = bhxx::empty<float>({3,4});
bhxx::empty<float> B = bhxx::empty<float>({4});
B.reset(A);

// Evaluation triggers:
bhxx::flush();
std::cout << A << "\n";
A.vec();
A.data();

// Operator overloads
A + B - C * E / G;

// Standard functions
bhxx::sin(A) + bhxx::cos(B) + bhxx::sqrt(C) + ...

// Reductions (sum, product, maximum, etc.)
bhxx::add_reduce(A, 0); // Sum of axis 0
bhxx::multiply_reduce(B, 1); // Product of axis 1
bhxx::maximum_reduce(C, 2); // Maximum of axis 2

The API¶

The following is the complete API as defined in the header file:

template <typename T>

class BhArray¶

#include <BhArray.hpp>

Representation of a multidimensional array that point to a BhBase array.

Template Parameters

T: The data type of the array and the underlying base array

Inherits from bhxx::BhArrayUnTypedCore

Public Types

typedef T scalar_type¶: The data type of each array element.

Public Functions

BhArray()¶: Default constructor that leave the instance completely uninitialized.

BhArray(Shape shape, Stride stride)¶

Create a new array. Shape and Stride must have the same length.

Parameters

shape: Shape of the new array
stride: Stride of the new array

BhArray(Shape shape)¶: Create a new array (contiguous stride, row-major)

BhArray(std::shared_ptr<BhBase> base, Shape shape, Stride stride, uint64_t offset = 0)¶

Create a array that points to the given base

Note: The caller should make sure that the shared pointer uses the RuntimeDeleter as its deleter, since this is implicitly assumed throughout, i.e. if one wants to construct a BhBase object, use the make_base_ptr helper function.

BhArray(std::shared_ptr<BhBase> base, Shape shape)¶

Create a view that points to the given base (contiguous stride, row-major)

Note: The caller should make sure that the shared pointer uses the RuntimeDeleter as its deleter, since this is implicitly assumed throughout, i.e. if one wants to construct a BhBase object, use the make_base_ptr helper function.

template <typename InType, typename std::enable_if< type_traits::is_safe_numeric_cast< scalar_type, InType >::value, int >::type = 0>

BhArray(const BhArray<InType> &ary)¶

Create a copy of ary using a Bohrium identity operation, which copies the underlying array data.

Note: This function implements implicit type conversion for all widening type casts

BhArray(const BhArray&)¶: Copy constructor that only copies meta data. The underlying array data is untouched

BhArray(BhArray&&)¶: Move constructor that only moves meta data. The underlying array data is untouched

BhArray<T> &operator=(const BhArray<T> &other)¶: Copy the data of other into the array using a Bohrium identity operation

BhArray<T> &operator=(BhArray<T> &&other)¶

Copy the data of other into the array using a Bohrium identity operation

Note: A move assignment is the same as a copy assignment.

template <typename InType, typename std::enable_if< type_traits::is_arithmetic< InType >::value, int >::type = 0>
BhArray<T> &operator=(const InType &scalar_value)¶: Copy the scalar of scalar_value into the array using a Bohrium identity operation

BhArray<T> copy() const¶: Return a new copy of the array using a Bohrium identity operation

void reset(BhArray<T> ary)¶: Reset the array to ary

void reset()¶: Reset the array by cleaning all meta data and leave the array uninitialized.

int rank() const¶: Return the rank (number of dimensions) of the array

uint64_t size() const¶: Return the total number of elements of the array

bool isContiguous() const¶: Return whether the view is contiguous and row-major

bool isDataInitialised() const¶: Is the data referenced by this view’s base array already allocated, i.e. initialised

const T *data(bool flush = true) const¶

Obtain the data pointer of the array, not taking ownership of any kind.

Return

The data pointer that might be a nullptr if the data in the base data is not initialised.

Parameters

flush: Should we flush the runtime system before retrieving the data pointer

T *data(bool flush = true)¶: The non-const version of .data()

std::vector<T> vec() const¶

Return a copy of the array as a standard vector

Note: The array must be contiguous

void pprint(std::ostream &os, int current_nesting_level, int max_nesting_level) const¶

Pretty printing the content of the array

Parameters

os: The output stream to write to.
current_nesting_level: The nesting level to print at (typically 0).
max_nesting_level: The maximum nesting level to print at (typically rank()-1).

BhArray<T> operator[](int64_t idx) const¶: Returns a new view of the idx dimension. Negative index counts from the back.

BhArray<T> transpose() const¶: Return a new transposed view.

BhArray<T> reshape(Shape shape) const¶: Return a new reshaped view (the array must be contiguous)

BhArray<T> newAxis(int axis) const¶

Return a new view with a “new axis” inserted.

Return

The new array

Parameters

axis: The “new axis” is inserted just before axis. If negative, the count is backwards (e.g -1 insert a “new axis” at the end of the array)

class BhArrayUnTypedCore¶

#include <BhArray.hpp>

Core class that represent the core attributes of a view that isn’t typed by its dtype

Subclassed by bhxx::BhArray< T >

Public Functions

BhArrayUnTypedCore()¶: Default constructor that leave the instance completely uninitialized

BhArrayUnTypedCore(uint64_t offset, Shape shape, Stride stride, std::shared_ptr<BhBase> base)¶: Constructor to initiate all but the _slides attribute

bh_view getBhView() const¶: Return a bh_view of the array

uint64_t offset() const¶: Return the offset of the array

const Shape &shape() const¶: Return the shape of the array

const Stride &stride() const¶: Return the stride of the array

const std::shared_ptr<BhBase> &base() const¶: Return the base of the array

std::shared_ptr<BhBase> &base()¶: Return the base of the array

void setShapeAndStride(Shape shape, Stride stride)¶: Set the shape and stride of the array (both must have the same length)

const bh_slide &slides() const¶: Return the slides object of the array

bh_slide &slides()¶: Return the slides object of the array

Protected Attributes

uint64_t _offset = 0¶: The array offset (from the start of the base in number of elements)

Shape _shape¶: The array shape (size of each dimension in number of elements)

Stride _stride¶: The array stride (the absolute stride of each dimension in number of elements)

std::shared_ptr<BhBase> _base¶: Pointer to the base of this array.

bh_slide _slides¶: Metadata to support sliding views.

Friends

void swap(BhArrayUnTypedCore &a, BhArrayUnTypedCore &b)¶: Swapping a and b

class BhBase¶

#include <BhBase.hpp>

The base underlying (multiple) arrays

Inherits from bh_base

Public Functions

bool ownMemory()¶

Is the memory managed referenced by bh_base’s data pointer managed by Bohrium or is it owned externally

Note: If this flag is false, the class will make sure that the memory is not deleted when going out of scope.

template <typename T>

BhBase(size_t nelem, T *memory)¶

Construct a base array with nelem elements using externally managed storage.

The class will make sure, that the storage is not deleted when going out of scope. Needless to say that the memory should be large enough to incorporate nelem_ elements.

Template Parameters

T: The type of each element

Parameters

nelem: Number of elements
memory: Pointer to the external memory

template <typename InputIterator, typename T = typename std::iterator_traits<InputIterator>::value_type>

BhBase(InputIterator begin, InputIterator end)¶

Construct a base array and initialise it with the elements provided by an iterator range.

The values are copied into the Bohrium storage. If you want to provide external storage to Bohrium use the constructor BhBase(size_t nelem, T* memory) instead.

template <typename T>

BhBase(T dummy, size_t nelem)¶

Construct a base array with nelem elements

Note

The use of this particular constructor is discouraged. It is only needed from BhArray to construct base objects which are uninitialised and do not yet hold any deta. If you wish to construct an uninitialised BhBase object, do this via the BhArray interface and not using this constructor.

Parameters

dummy: Dummy argument to fix the type of elements used. It may only have ever have the value 0 in the appropriate type.
nelem: Number of elements

~BhBase()¶: Destructor

BhBase(const BhBase&)¶: Deleted copy constructor

BhBase &operator=(const BhBase&)¶: Deleted copy assignment

BhBase &operator=(BhBase &&other)¶: Delete move assignment

BhBase(BhBase &&other)¶: Move another BhBase object here

Private Members

bool m_own_memory¶

class Random¶

#include <random.hpp>

Random class that maintain the state of the random number generation

Public Functions

Random(uint64_t seed = std::random_device{}())¶

Create a new random instance

Parameters

seed: T he seed of the random number generation. If not set, std::random_device is used.

BhArray<uint64_t> random123(uint64_t size)¶

New 1D random array using the Random123 algorithm https://www.deshawresearch.com/resources_random123.html

Return

The new random array

Parameters

size: Size of the new 1D random array

void reset(uint64_t seed = std::random_device{}())¶

Reset the random instance

Parameters

seed: The seed of the random number generation. If not set, std::random_device is used.

template <typename T>

BhArray<T> randn(Shape shape)¶

Return random floats in the half-open interval [0.0, 1.0) using Random123

Return

Real array

Parameters

shape: The shape of the returned array

Private Members

uint64_t _seed¶

uint64_t _count = 0¶

namespace bhxx¶

Typedefs

typedef BhStaticVector<uint64_t> Shape¶: Static allocated shape that is interchangeable with standard C++ vector as long as the vector is smaller than BH_MAXDIM.

typedef BhStaticVector<int64_t> Stride¶: Static allocated stride that is interchangeable with standard C++ vector as long as the vector is smaller than BH_MAXDIM.

Functions

template <typename T>

BhArray<T> arange(int64_t start, int64_t stop, int64_t step)¶

Return evenly spaced values within a given interval.

Return

New 1D array

Template Parameters

T: Data type of the returned array

Parameters

start: Start of interval. The interval includes this value.
stop: End of interval. The interval does not include this value.
step: Spacing between values. For any output out, this is the distance between two adjacent values, out[i+1] - out[i].

void flush()¶: Force the execution of all lazy evaluated array operations

template <typename T>

BhArray<T> empty(Shape shape)¶

Return a new empty array

Return

The new array

Template Parameters

T: The data type of the new array

Parameters

shape: The shape of the new array

template <typename OutType, typename InType>

BhArray<OutType> empty_like(const bhxx::BhArray<InType> &ary)¶

Return a new empty array that has the same shape as ary

Return

The new array

Template Parameters

OutType: The data type of the returned new array
InType: The data type of the input array

Parameters

ary: The array to take the shape from

template <typename T>

BhArray<T> full(Shape shape, T value)¶

Return a new array filled with value

Return

The new array

Template Parameters

T: The data type of the new array

Parameters

shape: The shape of the new array
value: The value to fill the new array with

template <typename T>

BhArray<T> zeros(Shape shape)¶

Return a new array filled with zeros

Return

The new array

Template Parameters

T: The data type of the new array

Parameters

shape: The shape of the new array

template <typename T>

BhArray<T> ones(Shape shape)¶

Return a new array filled with ones

Return

The new array

Template Parameters

T: The data type of the new array

Parameters

shape: The shape of the new array

template <typename T>

BhArray<T> arange(int64_t start, int64_t stop)¶

Return evenly spaced values within a given interval using steps of 1.

Return

New 1D array

Template Parameters

T: Data type of the returned array

Parameters

start: Start of interval. The interval includes this value.
stop: End of interval. The interval does not include this value.

template <typename T>

BhArray<T> arange(int64_t stop)¶

Return evenly spaced values from 0 to stop using steps of 1.

Return

New 1D array

Template Parameters

T: Data type of the returned array

Parameters

stop: End of interval. The interval does not include this value.

template <typename OutType, typename InType>

BhArray<OutType> cast(const bhxx::BhArray<InType> &ary)¶

Element-wise static_cast.

Return

New array

Template Parameters

OutType: The data type of the returned array
InType: The data type of the input array

Parameters

ary: Input array to cast

Stride contiguous_stride(const Shape &shape)¶: Return a contiguous stride (row-major) based on shape

template <typename T>

std::ostream &operator<<(std::ostream &os, const BhArray<T> &ary)¶

Pretty printing the data of an array to a stream Example:

auto A = bhxx::arange<double>(3);
std::cout << A << std::endl;

Return

A reference to os

Template Parameters

T: The data of ary

Parameters

os: The output stream to write to
ary: The array to print

template <typename T>

BhArray<T> as_contiguous(BhArray<T> ary)¶

Create an contiguous view or a copy of an array. The array is only copied if it isn’t already contiguous.

Return

Either a view of ary or a new copy of ary.

Template Parameters

T: The data type of ary.

Parameters

ary: The array to make contiguous.

template <int N>

Shape broadcasted_shape(std::array<Shape, N> shapes)¶

Return the result of broadcasting shapes against each other

Return

Broadcasted shape

Parameters

shapes: Array of shapes

template <typename T>

BhArray<T> broadcast_to(BhArray<T> ary, const Shape &shape)¶

Return a new view of ary that is broadcasted to shape We use the term broadcast as defined by NumPy. Let ret be the broadcasted view of ary: 1) One-sized dimensions are prepended to ret.shape() until it has the same number of dimension as ary. 2) The stride of each one-sized dimension in ret is set to zero. 3) The shape of ary is set to shape

Note

See: https://docs.scipy.org/doc/numpy-1.15.0/user/basics.broadcasting.html

Return

The broadcasted array

Parameters

ary: Input array
shape: The new shape

template <typename T1, typename T2>

bool is_same_array(const BhArray<T1> &a, const BhArray<T2> &b)¶

Check whether a and b are the same view pointing to the same base

Return

The boolean answer.

Template Parameters

T1: The data type of a.
T2: The data type of b.

Parameters

a: The first array to compare.
b: The second array to compare.

template <typename T1, typename T2>

bool may_share_memory(const BhArray<T1> &a, const BhArray<T2> &b)¶

Check whether a and b can share memory

Note

A return of True does not necessarily mean that the two arrays share any element. It just means that they might.

Return

The boolean answer.

Template Parameters

T1: The data type of a.
T2: The data type of b.

Parameters

a: The first array to compare.
b: The second array to compare.

BhArray<bool> add(const BhArray<bool> &in1, const BhArray<bool> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<bool> add(const BhArray<bool> &in1, bool in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<bool> add(bool in1, const BhArray<bool> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<std::complex<double>> add(const BhArray<std::complex<double>> &in1, const BhArray<std::complex<double>> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<std::complex<double>> add(const BhArray<std::complex<double>> &in1, std::complex<double> in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<std::complex<double>> add(std::complex<double> in1, const BhArray<std::complex<double>> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<std::complex<float>> add(const BhArray<std::complex<float>> &in1, const BhArray<std::complex<float>> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<std::complex<float>> add(const BhArray<std::complex<float>> &in1, std::complex<float> in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<std::complex<float>> add(std::complex<float> in1, const BhArray<std::complex<float>> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<float> add(const BhArray<float> &in1, const BhArray<float> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<float> add(const BhArray<float> &in1, float in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<float> add(float in1, const BhArray<float> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<double> add(const BhArray<double> &in1, const BhArray<double> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<double> add(const BhArray<double> &in1, double in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<double> add(double in1, const BhArray<double> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int16_t> add(const BhArray<int16_t> &in1, const BhArray<int16_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int16_t> add(const BhArray<int16_t> &in1, int16_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int16_t> add(int16_t in1, const BhArray<int16_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int32_t> add(const BhArray<int32_t> &in1, const BhArray<int32_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int32_t> add(const BhArray<int32_t> &in1, int32_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int32_t> add(int32_t in1, const BhArray<int32_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int64_t> add(const BhArray<int64_t> &in1, const BhArray<int64_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int64_t> add(const BhArray<int64_t> &in1, int64_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int64_t> add(int64_t in1, const BhArray<int64_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int8_t> add(const BhArray<int8_t> &in1, const BhArray<int8_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int8_t> add(const BhArray<int8_t> &in1, int8_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int8_t> add(int8_t in1, const BhArray<int8_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint16_t> add(const BhArray<uint16_t> &in1, const BhArray<uint16_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint16_t> add(const BhArray<uint16_t> &in1, uint16_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint16_t> add(uint16_t in1, const BhArray<uint16_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint32_t> add(const BhArray<uint32_t> &in1, const BhArray<uint32_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint32_t> add(const BhArray<uint32_t> &in1, uint32_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint32_t> add(uint32_t in1, const BhArray<uint32_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint64_t> add(const BhArray<uint64_t> &in1, const BhArray<uint64_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint64_t> add(const BhArray<uint64_t> &in1, uint64_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint64_t> add(uint64_t in1, const BhArray<uint64_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint8_t> add(const BhArray<uint8_t> &in1, const BhArray<uint8_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint8_t> add(const BhArray<uint8_t> &in1, uint8_t in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint8_t> add(uint8_t in1, const BhArray<uint8_t> &in2)¶

Add arguments element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<std::complex<double>> subtract(const BhArray<std::complex<double>> &in1, const BhArray<std::complex<double>> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<std::complex<double>> subtract(const BhArray<std::complex<double>> &in1, std::complex<double> in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<std::complex<double>> subtract(std::complex<double> in1, const BhArray<std::complex<double>> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<std::complex<float>> subtract(const BhArray<std::complex<float>> &in1, const BhArray<std::complex<float>> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<std::complex<float>> subtract(const BhArray<std::complex<float>> &in1, std::complex<float> in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<std::complex<float>> subtract(std::complex<float> in1, const BhArray<std::complex<float>> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<float> subtract(const BhArray<float> &in1, const BhArray<float> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<float> subtract(const BhArray<float> &in1, float in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<float> subtract(float in1, const BhArray<float> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<double> subtract(const BhArray<double> &in1, const BhArray<double> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<double> subtract(const BhArray<double> &in1, double in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<double> subtract(double in1, const BhArray<double> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int16_t> subtract(const BhArray<int16_t> &in1, const BhArray<int16_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int16_t> subtract(const BhArray<int16_t> &in1, int16_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int16_t> subtract(int16_t in1, const BhArray<int16_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int32_t> subtract(const BhArray<int32_t> &in1, const BhArray<int32_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int32_t> subtract(const BhArray<int32_t> &in1, int32_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int32_t> subtract(int32_t in1, const BhArray<int32_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int64_t> subtract(const BhArray<int64_t> &in1, const BhArray<int64_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int64_t> subtract(const BhArray<int64_t> &in1, int64_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int64_t> subtract(int64_t in1, const BhArray<int64_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<int8_t> subtract(const BhArray<int8_t> &in1, const BhArray<int8_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<int8_t> subtract(const BhArray<int8_t> &in1, int8_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<int8_t> subtract(int8_t in1, const BhArray<int8_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint16_t> subtract(const BhArray<uint16_t> &in1, const BhArray<uint16_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint16_t> subtract(const BhArray<uint16_t> &in1, uint16_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint16_t> subtract(uint16_t in1, const BhArray<uint16_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint32_t> subtract(const BhArray<uint32_t> &in1, const BhArray<uint32_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint32_t> subtract(const BhArray<uint32_t> &in1, uint32_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint32_t> subtract(uint32_t in1, const BhArray<uint32_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint64_t> subtract(const BhArray<uint64_t> &in1, const BhArray<uint64_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint64_t> subtract(const BhArray<uint64_t> &in1, uint64_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint64_t> subtract(uint64_t in1, const BhArray<uint64_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<uint8_t> subtract(const BhArray<uint8_t> &in1, const BhArray<uint8_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Array input.

BhArray<uint8_t> subtract(const BhArray<uint8_t> &in1, uint8_t in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Array input.
in2: Scalar input.

BhArray<uint8_t> subtract(uint8_t in1, const BhArray<uint8_t> &in2)¶

Subtract arguments, element-wise.

Return

Output array.

Parameters

in1: Scalar input.
in2: Array input.

BhArray<bool> multiply(const BhArray<bool> &in1, const BhArray<bool> &in2)¶