forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
apacheGH-37232: [MATLAB] Add
arrow.type.Time64Type class and `arrow…
….time64` construction function (apache#37287) ### Rationale for this change To add support for `arrow.array.Time64Array`, we will need to add support for a `arrow.type.Time64Type` class and associated `arrow.time64` construction function to the MATLAB interface. ### What changes are included in this PR? 1. New `arrow.type.Time64Type` class. 2. New `arrow.time64` construction function that returns an `arrow.type.Time64Type` instance. **Example** ```matlab >> type = arrow.time64(TimeUnit="Nanosecond") type = Time64Type with properties: ID: Time64 TimeUnit: Nanosecond >> class(type) ans = 'arrow.type.Time64Type' ``` ### Are these changes tested? Yes. 1. Added a new test class `tTime64Type`. 2. Added new tests for `Time64` type ID enumeration to `tID`. ### Are there any user-facing changes? Yes. 1. `arrow.time64` construction function 3. `arrow.type.Time64Type` class ### Future Directions 1. apache#37229 2. apache#37230 3. Add `arrow.array.Time64Array` class * Closes: apache#37232 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
- Loading branch information
1 parent
f01f1bf
commit 1a03dae
Showing
9 changed files
with
292 additions
and
2 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 "arrow/matlab/type/proxy/time64_type.h" | ||
| #include "arrow/matlab/type/time_unit.h" | ||
| #include "arrow/matlab/error/error.h" | ||
| #include "arrow/util/utf8.h" | ||
|
|
||
| namespace arrow::matlab::type::proxy { | ||
|
|
||
| Time64Type::Time64Type(std::shared_ptr<arrow::Time64Type> time64_type) : TimeType(std::move(time64_type)) {} | ||
|
|
||
| libmexclass::proxy::MakeResult Time64Type::make(const libmexclass::proxy::FunctionArguments& constructor_arguments) { | ||
| namespace mda = ::matlab::data; | ||
|
|
||
| using Time64TypeProxy = arrow::matlab::type::proxy::Time64Type; | ||
|
|
||
| mda::StructArray opts = constructor_arguments[0]; | ||
|
|
||
| const mda::StringArray timeunit_mda = opts[0]["TimeUnit"]; | ||
|
|
||
| // extract the time unit | ||
| const std::u16string& utf16_timeunit = timeunit_mda[0]; | ||
| MATLAB_ASSIGN_OR_ERROR(const auto timeunit, | ||
| arrow::matlab::type::timeUnitFromString(utf16_timeunit), | ||
| error::UKNOWN_TIME_UNIT_ERROR_ID); | ||
|
|
||
| auto type = arrow::time64(timeunit); | ||
| auto time_type = std::static_pointer_cast<arrow::Time64Type>(type); | ||
| return std::make_shared<Time64TypeProxy>(std::move(time_type)); | ||
| } | ||
| } |
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,36 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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/matlab/type/proxy/time_type.h" | ||
|
|
||
| namespace arrow::matlab::type::proxy { | ||
|
|
||
| class Time64Type : public arrow::matlab::type::proxy::TimeType { | ||
|
|
||
| public: | ||
| Time64Type(std::shared_ptr<arrow::Time64Type> time64_type); | ||
|
|
||
| ~Time64Type() {} | ||
|
|
||
| static libmexclass::proxy::MakeResult make(const libmexclass::proxy::FunctionArguments& constructor_arguments); | ||
|
|
||
| }; | ||
|
|
||
| } | ||
|
|
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,30 @@ | ||
| %TIME64TYPE Type class for time64 data. | ||
|
|
||
| % Licensed to the Apache Software Foundation (ASF) under one or more | ||
| % contributor license agreements. See the NOTICE file distributed with | ||
| % this work for additional information regarding copyright ownership. | ||
| % The ASF licenses this file to you 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. | ||
|
|
||
| classdef Time64Type < arrow.type.TimeType | ||
|
|
||
| methods | ||
| function obj = Time64Type(proxy) | ||
| arguments | ||
| proxy(1, 1) libmexclass.proxy.Proxy {validate(proxy, "arrow.type.proxy.Time64Type")} | ||
| end | ||
| import arrow.internal.proxy.validate | ||
| obj@arrow.type.TimeType(proxy); | ||
| end | ||
| end | ||
|
|
||
| end |
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,26 @@ | ||
| %TIME64 Creates an arrow.type.Time64Type object | ||
|
|
||
| % Licensed to the Apache Software Foundation (ASF) under one or more | ||
| % contributor license agreements. See the NOTICE file distributed with | ||
| % this work for additional information regarding copyright ownership. | ||
| % The ASF licenses this file to you 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. | ||
|
|
||
| function type = time64(opts) | ||
| arguments | ||
| opts.TimeUnit(1, 1) arrow.type.TimeUnit {timeUnit("Time64", opts.TimeUnit)} = arrow.type.TimeUnit.Microsecond | ||
| end | ||
| import arrow.internal.validate.temporal.timeUnit | ||
| args = struct(TimeUnit=string(opts.TimeUnit)); | ||
| proxy = arrow.internal.proxy.create("arrow.type.proxy.Time64Type", args); | ||
| type = arrow.type.Time64Type(proxy); | ||
| end |
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,146 @@ | ||
| %TTIME64TYPE Test class for arrow.type.Time64Type and arrow.time64 | ||
|
|
||
| % Licensed to the Apache Software Foundation (ASF) under one or more | ||
| % contributor license agreements. See the NOTICE file distributed with | ||
| % this work for additional information regarding copyright ownership. | ||
| % The ASF licenses this file to you 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. | ||
|
|
||
| classdef tTime64Type < hFixedWidthType | ||
|
|
||
| properties | ||
| ConstructionFcn = @arrow.time64 | ||
| ArrowType = arrow.time64 | ||
| TypeID = arrow.type.ID.Time64 | ||
| BitWidth = int32(64) | ||
| ClassName = "arrow.type.Time64Type" | ||
| end | ||
|
|
||
| methods(Test) | ||
| function TestClass(testCase) | ||
| % Verify ArrowType is an object of the expected class type. | ||
| name = string(class(testCase.ArrowType)); | ||
| testCase.verifyEqual(name, testCase.ClassName); | ||
| end | ||
|
|
||
| function DefaultTimeUnit(testCase) | ||
| % Verify the default TimeUnit is Microsecond. | ||
| type = testCase.ArrowType; | ||
| actualUnit = type.TimeUnit; | ||
| expectedUnit = arrow.type.TimeUnit.Microsecond; | ||
| testCase.verifyEqual(actualUnit, expectedUnit); | ||
| end | ||
|
|
||
| function SupplyTimeUnitEnum(testCase) | ||
| % Verify that TimeUnit can be specified as an enum value. | ||
| import arrow.type.* | ||
| expectedUnit = [TimeUnit.Microsecond, TimeUnit.Nanosecond]; | ||
|
|
||
| for unit = expectedUnit | ||
| type = testCase.ConstructionFcn(TimeUnit=unit); | ||
| testCase.verifyEqual(type.TimeUnit, unit); | ||
| end | ||
| end | ||
|
|
||
| function SupplyTimeUnitString(testCase) | ||
| % Supply TimeUnit as a string value. Verify TimeUnit is set to | ||
| % the appropriate TimeUnit enum value. | ||
| import arrow.type.* | ||
| unitString = ["Microsecond", "Nanosecond"]; | ||
| expectedUnit = [TimeUnit.Microsecond, TimeUnit.Nanosecond]; | ||
|
|
||
| for ii = 1:numel(unitString) | ||
| type = testCase.ConstructionFcn(TimeUnit=unitString(ii)); | ||
| testCase.verifyEqual(type.TimeUnit, expectedUnit(ii)); | ||
| end | ||
| end | ||
|
|
||
| function ErrorIfAmbiguousTimeUnit(testCase) | ||
| % Verify that an error is thrown if an ambiguous value is | ||
| % provided for the TimeUnit name-value pair. | ||
| fcn = @() testCase.ConstructionFcn(TimeUnit="mi"); | ||
| testCase.verifyError(fcn, "MATLAB:validation:UnableToConvert"); | ||
| end | ||
|
|
||
| function ErrorIfTimeUnitIsNonScalar(testCase) | ||
| % Verify that an error is thrown if a nonscalar value is | ||
| % provided for the TimeUnit name-value pair. | ||
| units = [arrow.type.TimeUnit.Microsecond; arrow.type.TimeUnit.Nanosecond]; | ||
| fcn = @() testCase.ConstructionFcn(TimeUnit=units); | ||
| testCase.verifyError(fcn, "MATLAB:validation:IncompatibleSize"); | ||
|
|
||
| units = ["Microsecond" "Nanosecond"]; | ||
| fcn = @() testCase.ConstructionFcn(TimeUnit=units); | ||
| testCase.verifyError(fcn, "MATLAB:validation:IncompatibleSize"); | ||
| end | ||
|
|
||
| function Display(testCase) | ||
| % Verify the display of Time64Type objects. | ||
| % | ||
| % Example: | ||
| % | ||
| % Time64Type with properties: | ||
| % | ||
| % ID: Time64 | ||
| % TimeUnit: Microsecond | ||
| % | ||
| type = testCase.ConstructionFcn(TimeUnit="Microsecond"); %#ok<NASGU> | ||
| classnameLink = "<a href=""matlab:helpPopup arrow.type.Time64Type"" style=""font-weight:bold"">Time64Type</a>"; | ||
| header = " " + classnameLink + " with properties:" + newline; | ||
| body = strjust(pad(["ID:"; "TimeUnit:"])); | ||
| body = body + " " + ["Time64"; "Microsecond"]; | ||
| body = " " + body; | ||
| footer = string(newline); | ||
| expectedDisplay = char(strjoin([header body' footer], newline)); | ||
| actualDisplay = evalc('disp(type)'); | ||
| testCase.verifyEqual(actualDisplay, expectedDisplay); | ||
| end | ||
|
|
||
| function TimeUnitNoSetter(testCase) | ||
| % Verify that an error is thrown when trying to set the value | ||
| % of the TimeUnit property. | ||
| schema = arrow.time64(TimeUnit="Nanosecond"); | ||
| testCase.verifyError(@() setfield(schema, "TimeUnit", "Microsecond"), "MATLAB:class:SetProhibited"); | ||
| end | ||
|
|
||
| function BitWidthNoSetter(testCase) | ||
| % Verify that an error is thrown when trying to set the value | ||
| % of the BitWidth property. | ||
| schema = arrow.time64(TimeUnit="Nanosecond"); | ||
| testCase.verifyError(@() setfield(schema, "BitWidth", 32), "MATLAB:class:SetProhibited"); | ||
| end | ||
|
|
||
| function IDNoSetter(testCase) | ||
| % Verify that an error is thrown when trying to set the value | ||
| % of the ID property. | ||
| schema = arrow.time64(TimeUnit="Nanosecond"); | ||
| testCase.verifyError(@() setfield(schema, "ID", 15), "MATLAB:class:SetProhibited"); | ||
| end | ||
|
|
||
| function NumFieldsNoSetter(testCase) | ||
| % Verify that an error is thrown when trying to set the value | ||
| % of the NumFields property. | ||
| schema = arrow.time64(TimeUnit="Nanosecond"); | ||
| testCase.verifyError(@() setfield(schema, "NumFields", 2), "MATLAB:class:SetProhibited"); | ||
| end | ||
|
|
||
| function InvalidProxy(testCase) | ||
| % Verify that an error is thrown when a Proxy of an unexpected | ||
| % type is passed to the arrow.type.Time64Type constructor. | ||
| array = arrow.array([1, 2, 3]); | ||
| proxy = array.Proxy; | ||
| testCase.verifyError(@() arrow.type.Time64Type(proxy), "arrow:proxy:ProxyNameMismatch"); | ||
| end | ||
|
|
||
| end | ||
|
|
||
| end |
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