Add encoding for FixedSizeBinary and FixedSizeList #129
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| // Copyright 2022 Lance Authors | ||
| // | ||
| // 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. | ||
|
|
||
| #include "lance/encodings/fixed_size_binary.h" | ||
|
|
||
| #include <arrow/builder.h> | ||
|
|
||
| #include "lance/arrow/type.h" | ||
| #include "lance/encodings/encoder.h" | ||
| #include "lance/encodings/plain.h" | ||
|
|
||
| namespace lance::encodings { | ||
|
|
||
| FixedSizeBinaryEncoder::FixedSizeBinaryEncoder( | ||
|
There was a problem hiding this comment. This is called FixedSizeBinaryEncoder/Decoder but it handles both FixedSizeBinary and FixedSizeList. Would it be better to call it FixedSizeEncoder/Decoder or something like that? There was a problem hiding this comment. Good point. So this encoding is in contrast to |
||
| const std::shared_ptr<::arrow::io::OutputStream>& out) noexcept | ||
| : Encoder(out) {} | ||
|
|
||
| FixedSizeBinaryEncoder::~FixedSizeBinaryEncoder() {} | ||
|
|
||
| ::arrow::Result<int64_t> FixedSizeBinaryEncoder::Write(const std::shared_ptr<::arrow::Array>& arr) { | ||
| assert(::arrow::is_fixed_size_binary(arr->type_id()) || | ||
| lance::arrow::is_fixed_size_list(arr->type())); | ||
|
|
||
| ARROW_ASSIGN_OR_RAISE(auto values_position, out_->Tell()); | ||
| if (::arrow::is_fixed_size_binary(arr->type_id())) { | ||
| auto a = std::static_pointer_cast<::arrow::FixedSizeBinaryArray>(arr); | ||
| ARROW_RETURN_NOT_OK(out_->Write(a->raw_values(), a->length() * a->byte_width())); | ||
| } else if (lance::arrow::is_fixed_size_list(arr->type())) { | ||
| auto list_arr = std::dynamic_pointer_cast<::arrow::FixedSizeListArray>(arr); | ||
|
There was a problem hiding this comment. why use a dynamic cast here? i thought we already first check that it's a FixedSizeListArray? There was a problem hiding this comment. So I was thinking of being consistent to use a dynamic cast to cast base class to child class. I should use the same in line 37 to use dynamic_cast tho. |
||
| assert(::arrow::is_primitive(list_arr->values()->type_id())); | ||
|
|
||
| auto plain_encoder = PlainEncoder(out_); | ||
| return plain_encoder.Write(list_arr->values()); | ||
| } | ||
|
|
||
| return values_position; | ||
| } | ||
|
|
||
| std::string FixedSizeBinaryEncoder::ToString() const { return "FixedSizeBinaryEncoder"; } | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> FixedSizedBinaryDecoder::ToFixedSizeBinaryArray( | ||
| int32_t start, int32_t length) const { | ||
| auto bytes = type_->byte_width(); | ||
|
There was a problem hiding this comment. nit: I'd probably call this nbytes or byte_width? |
||
| ARROW_ASSIGN_OR_RAISE(auto buf, infile_->ReadAt(position_ + start * bytes, length * bytes)); | ||
|
There was a problem hiding this comment. So for fixed size binary it's just a plain encoder/decoder using fixed width data (e.g., any of the numeric dtypes) right? How come we don't just call plain_decoder like you do with the fixed size list handling? There was a problem hiding this comment. Yes , we can definitely do it. |
||
| return std::make_shared<::arrow::FixedSizeBinaryArray>(type_, length, buf); | ||
| } | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> FixedSizedBinaryDecoder::ToFixedSizeListArray( | ||
| int32_t start, int32_t length) const { | ||
| auto fixed_list_type = std::dynamic_pointer_cast<::arrow::FixedSizeListType>(type_); | ||
| auto value_type = fixed_list_type->value_field(); | ||
| assert(::arrow::is_primitive(value_type->type()->id())); | ||
| auto plain_decoder = PlainDecoder(infile_, value_type->type()); | ||
| ARROW_RETURN_NOT_OK(plain_decoder.Init()); | ||
|
|
||
| auto list_size = fixed_list_type->list_size(); | ||
| plain_decoder.Reset(position_, length_ * list_size); | ||
| ARROW_ASSIGN_OR_RAISE(auto values, plain_decoder.ToArray(start * list_size, length * list_size)); | ||
| return std::make_shared<::arrow::FixedSizeListArray>(type_, length, values); | ||
| } | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> FixedSizedBinaryDecoder::ToArray( | ||
| int32_t start, std::optional<int32_t> length) const { | ||
| if (!length.has_value()) { | ||
| length = length_ - start; | ||
| } | ||
| if (start + length.value() > length_ || start > length_) { | ||
| return ::arrow::Status::IndexError( | ||
| fmt::format("{}::ToArray: out of range: start={}, length={}, page_length={}\n", | ||
| ToString(), | ||
| start, | ||
| length.value(), | ||
| length_)); | ||
| } | ||
| if (lance::arrow::is_fixed_size_list(type_)) { | ||
| return ToFixedSizeListArray(start, length.value()); | ||
| } else if (::arrow::is_fixed_size_binary(type_->id())) { | ||
| return ToFixedSizeBinaryArray(start, length.value()); | ||
| } | ||
| return ::arrow::Status::Invalid("Invalid data type: {}\n", type_->ToString()); | ||
| } | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> FixedSizedBinaryDecoder::Take( | ||
| std::shared_ptr<::arrow::Int32Array> indices) const { | ||
| std::shared_ptr<::arrow::ArrayBuilder> builder; | ||
| if (lance::arrow::is_fixed_size_list(type_)) { | ||
| auto list_type = std::dynamic_pointer_cast<::arrow::FixedSizeListType>(type_); | ||
|
There was a problem hiding this comment. same question here wrt dynamic cast |
||
| ARROW_ASSIGN_OR_RAISE(auto value_builder, | ||
| ::lance::arrow::GetArrayBuilder(list_type->value_type())); | ||
| builder = std::make_shared<::arrow::FixedSizeListBuilder>(pool_, value_builder, type_); | ||
| } else if (::arrow::is_fixed_size_binary(type_->id())) { | ||
| builder = std::make_shared<::arrow::FixedSizeBinaryBuilder>(type_); | ||
| } else { | ||
| return ::arrow::Status::Invalid("FixedSizeBuilderDecoder::Take: Invalid data type: ", type_); | ||
| } | ||
|
|
||
| // TODO: Use thread pool | ||
|
There was a problem hiding this comment. Should this be done for all decoders? Or just ones where we may end up reading large amounts of data for each scalar? There was a problem hiding this comment. This should be done if we choose to pick "scalar" individually. Usually it works better for the case where scalar is big, i.e., large binary, tensors, images and etc. Other cases, i.e., for numeric values, it is faster to read a block and then filter them. (i.e., 64KB = 8000 int64 values in one read) |
||
| for (int i = 0; i < indices->length(); i++) { | ||
| ARROW_ASSIGN_OR_RAISE(auto scalar, GetScalar(indices->Value(i))); | ||
| ARROW_RETURN_NOT_OK(builder->AppendScalar(*scalar)); | ||
| } | ||
| return builder->Finish(); | ||
| } | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Scalar>> FixedSizedBinaryDecoder::GetScalar( | ||
| int64_t idx) const { | ||
| ARROW_ASSIGN_OR_RAISE(auto arr, ToArray(idx, 1)); | ||
| return arr->GetScalar(0); | ||
| }; | ||
|
|
||
| std::string FixedSizedBinaryDecoder::ToString() const { return "FixedSizeBinaryDecoder"; } | ||
|
|
||
| } // namespace lance::encodings | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Copyright 2022 Lance Authors | ||
| // | ||
| // 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. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <arrow/array.h> | ||
| #include <arrow/io/api.h> | ||
|
|
||
| #include <memory> | ||
|
|
||
| #include "lance/encodings/encoder.h" | ||
|
|
||
| namespace lance::encodings { | ||
|
|
||
| /// Fixed length binary encoder | ||
| class FixedSizeBinaryEncoder : public Encoder { | ||
| public: | ||
| FixedSizeBinaryEncoder(const std::shared_ptr<::arrow::io::OutputStream>& out) noexcept; | ||
|
|
||
| ~FixedSizeBinaryEncoder() override; | ||
|
|
||
| /// Write an fixed-size array, and returns the offsets to the index block. | ||
| ::arrow::Result<int64_t> Write(const std::shared_ptr<::arrow::Array>& arr) override; | ||
|
|
||
| [[nodiscard]] std::string ToString() const override; | ||
| }; | ||
|
|
||
| /// Fixed size binary decoder. | ||
| class FixedSizedBinaryDecoder : public Decoder { | ||
| public: | ||
| using Decoder::Decoder; | ||
|
|
||
| virtual ~FixedSizedBinaryDecoder() = default; | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Scalar>> GetScalar(int64_t idx) const override; | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> ToArray( | ||
| int32_t start = 0, std::optional<int32_t> length = std::nullopt) const override; | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> Take( | ||
| std::shared_ptr<::arrow::Int32Array> indices) const override; | ||
|
|
||
| [[nodiscard]] std::string ToString() const; | ||
|
|
||
| private: | ||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> ToFixedSizeBinaryArray(int32_t start, | ||
| int32_t length) const; | ||
|
|
||
| ::arrow::Result<std::shared_ptr<::arrow::Array>> ToFixedSizeListArray(int32_t start, | ||
| int32_t length) const; | ||
| }; | ||
|
|
||
| } // namespace lance::encodings |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only for numeric types?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to support more.