Add a vector class to GridKit#418
Conversation
PhilipFackler
left a comment
There was a problem hiding this comment.
For an all-in-one solution like this, I would prefer some revisions as explained in my line comments. None of those is a deal-breaker if this is meant only for "advanced" use-cases, but I still think it would be helpful.
| class Vector | ||
| { | ||
| public: | ||
| Vector(IdxT n); |
There was a problem hiding this comment.
This would need a default constructor for use in the phasor dynamics initialization.
There was a problem hiding this comment.
With default constructor, we would need allocate and/or reallocate methods, as well.
| case HOST: | ||
| if (h_data_ == nullptr) | ||
| { | ||
| h_data_ = new ScalarT[n_capacity_ * k_]; |
There was a problem hiding this comment.
It doesn't make sense for allocating to be part of the semantics of this function. It certainly wouldn't be obvious to me as a user that this might happen. I'm used to having no implicit memory operations, only explicit (the user has to say so). This should at least be documented if not reconsidered.
There was a problem hiding this comment.
Yes, you are right, this should be removed.
| * you are doing. | ||
| */ | ||
| template <typename ScalarT, typename IdxT> | ||
| int Vector<ScalarT, IdxT>::setData(ScalarT* data, memory::MemorySpace memspace) |
There was a problem hiding this comment.
This would make more sense as part of a constructor. An instance should be constructed with ownership and data (if non-owning) for host and device respectively. Ownership should not be allowed to change. And I think the data you're wrapping in the non-owning case shouldn't be allowed to change either. This function wouldn't exist in that case.
There was a problem hiding this comment.
I agree, changing ownership after construction is looking for trouble.
This method was experimental and should not be a part of the vector class.
There was a problem hiding this comment.
This method was used to get a vector from a multivector. Better solution is to construct non-data-owning vector object instead, or create a separate VectorView object as @lukelowry suggested.
| delete[] h_data_; | ||
| h_data_ = new ScalarT[n_capacity_ * k_]; | ||
| owns_cpu_data_ = true; |
There was a problem hiding this comment.
This ignores the case where we're already non-owning. See my comment above. If ownership was settled at construction there could be tighter invariants for the rest of these functions.
There was a problem hiding this comment.
I think it would be good to have allocate and reallocate methods, both refusing to operate on data if not owned by the vector object.
allocateshould return error message and do nothing if data pointer is not null.reallocateshould check if the new size is larger than capacity and if so delete previous and allocate new data.
All of your suggestions are spot on and should be incorporated before this PR is merged. |
Description
Add vector class to GridKit to replace
std::vectorand provide portable data management.Proposed changes
The
LinearAlgebra::Vectorclass was ported from Re::Solve. It has basic initialization and data management functionality. I can be use as a vector, multivector or vector view class.Checklist
-Wall -Wpedantic -Wconversion -Wextra.Further comments
The multivector capability in this class should replace
DenseMatrixobject in GridKit.