Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstring Added for HostWrite Constructor #126

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Docstring Added for HostWrite Constructor #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/Omega_h_array.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,21 @@ class HostWrite {
using value_type = T;
HostWrite() = default;
HostWrite(LO size_in, std::string const& name = "");

/**
* \brief Constructs a HostWrite object with specified size, offset, and stride.
*
* \param size_in The number of entries in the array.
* \param offset The initial value to set for the first entry of the array.
* \param stride The difference between the values of consecutive entries in the array.
* \param name The name of the array for identification purposes (default is an empty string).
*
* This constructor initializes a HostWrite array with the given size, setting the first entry to the specified offset,
* and each subsequent entry to the previous entry's value plus the stride. The array is given a name for identification.
* For example, `HostWrite<Real> h_write(10, 7.0, 0.0);` will create a write array of size 10 and all filled with 7.0.
*/
HostWrite(LO size_in, T offset, T stride, std::string const& name = "");

HostWrite(Write<T> write_in);
HostWrite(std::initializer_list<T> l, std::string const& name = "");
Write<T> write() const;
Expand Down