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

Jump to bottom

GH-37231: [MATLAB] Add arrow.type.Time32Type class and arrow.time32 construction function #37250

Merged
merged 13 commits into from
Aug 18, 2023
Merged

GH-37231: [MATLAB] Add arrow.type.Time32Type class and arrow.time32 construction function #37250

merged 13 commits into from
Aug 18, 2023

Conversation

kevingurney
Copy link
Member

@kevingurney kevingurney commented Aug 18, 2023 •
edited

Rationale for this change

To support the addition of arrow.array.Time32Array, this pull request adds a new arrow.type.Time32Type class and associated arrow.time32 construction function to the MATLAB interface.

What changes are included in this PR?

  1. New arrow.type.Time32Type class.
  2. New arrow.time32 construction function that returns an arrow.type.Time32Type instance.

Example

>> type = arrow.time32(TimeUnit="Millisecond")

type = 

  Time32Type with properties:

          ID: Time32
    TimeUnit: Millisecond

>> class(type)

ans =

    'arrow.type.Time32Type'

Are these changes tested?

Yes.

  1. Added new tests for Time32 type ID enumeration to tID.
  2. Added a test class tTimeUnit for the new validation function arrow.internal.validate.temporal.timeUnit.
  3. Added a new test class tTime32Type.

Are there any user-facing changes?

Yes.

There are two new user-facing APIs:

  1. arrow.time32 construction function
  2. arrow.type.Time32Type class

Future Directions:

  1. [MATLAB] Add arrow.type.Time64Type class and arrow.time64 construction function #37232
  2. [MATLAB] Add arrow.type.Date32Type class and arrow.date32 construction function #37229
  3. [MATLAB] Add arrow.type.Date64Type class and arrow.date64 construction function #37230
  4. [MATLAB] Make arrow.type.TemporalType a "tag" class #37251

Notes

  1. Thank you @sgilmore10 for your help with this pull request!

@kevingurney kevingurney marked this pull request as ready for review August 18, 2023 18:12
@kevingurney kevingurney requested a review from kou as a code owner August 18, 2023 18:12
sgilmore10 and others added 10 commits August 18, 2023 14:27
@sgilmore10 @kevingurney
Add arrow.type.Time32Type MATLAB class
7d6d9ac
@sgilmore10 @kevingurney
remove whitespace
0415c7c
@kevingurney @sgilmore10
Add basic arrow.time32 construction function implementation.
51226a0 
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
@kevingurney @sgilmore10
Add Time32 type enumeration ID.
11c8494 
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
@kevingurney
Add Time32Type proxy class.
f7013cf
@kevingurney
1. Remove TimeZone name-value pair from arrow.int32() construction
a1a2809 
function.
2. Fix capitalization of arrow.internal.validate.temporal.timeUnit.
@kevingurney
Add time32_type.cc to CMake sources.
b3f4f31
@kevingurney
Remove registration of getTimeZone method.
db1dc51
@kevingurney
Fix typo in arrow.time32 construction function.
8dca1b6
@kevingurney
1. Update display for Time32Type.
104242d 
2. Add tests for Time32Type class, arrow.internal.validate.temporal.timeUnit function,
and arrow.time32 construction function.
@kevingurney kevingurney mentioned this pull request Aug 18, 2023
Closed
@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Aug 18, 2023
@kevingurney @sgilmore10
Remove comment about mxarray access.
0812f15 
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
@github-actions github-actions bot added awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Aug 18, 2023
@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Aug 18, 2023
@kevingurney
Copy link
Member Author

+1

@kevingurney kevingurney merged commit ec1602c into apache:main Aug 18, 2023
8 checks passed
@kevingurney kevingurney removed the awaiting change review Awaiting change review label Aug 18, 2023
@kevingurney kevingurney deleted the GH-37231 branch August 18, 2023 20:05
@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ec1602c.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them.

This was referenced Aug 21, 2023
Closed
Closed
This was referenced Aug 21, 2023
Closed
Merged
@kevingurney kevingurney mentioned this pull request Aug 22, 2023
Merged
kevingurney added a commit that referenced this pull request Aug 22, 2023
@kevingurney
GH-37253: [MATLAB] Add test cases which verify that the NumFields, …
faa4652 
…`BitWidth`, and `ID` properties can not be modified to `hFixedWidth` test class (#37316)

### Rationale for this change

As @ sgilmore10 pointed out in #37250 (comment), it makes sense to move the tests which verify that the `NumFields`, `BitWidth`, and `ID` properties cannot be set into the `hFixedWidthType` superclass, rather than having these tests implemented in `tTime32Type` and `tTime64Type`, since they are common to all fixed width types.

### What changes are included in this PR?

1. Moved tests which verify that the `BitWidth`, `NumFields`, and `ID` properties cannot be set out of the `tTime32Type` and `tTime64Type` classes and into the superclass `hFixedWidthType`.
2. Fixed typo in `tTime32Type` and `tTime64Type`. Changed variable name `schema` to `type`.

### Are these changes tested?

Yes.

1. Moved tests which verify that the `BitWidth`, `NumFields`, and `ID` properties cannot be set out of the `tTime32Type` and `tTime64Type` classes and into the superclass `hFixedWidthType`.

### Are there any user-facing changes?

No.

This pull request only modifies tests.
* Closes: #37253

Authored-by: Kevin Gurney <kgurney@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
kou pushed a commit that referenced this pull request Aug 23, 2023
@sgilmore10
GH-37290: [MATLAB] Add arrow.array.Time32Array class (#37315)
0781f13 
### Rationale for this change

Now that the `arrow.type.Time32Type` class has been added to the MATLAB Interface (#37250), we can add the `arrow.array.Time32Array` class. 

### What changes are included in this PR?

1. Added a new class `arrow.array.Time32Array`. It has the following read-only properties: `Type` and `Length`. It has the following methods: `fromMATLAB()`, `toMATLAB()`, and `duration()`. For reference, `duration` arrays in MATLAB represent lengths of time in fixed-length units. Here's a [link](https://www.mathworks.com/help/matlab/ref/duration.html) to the documentation. 
2. Added a new class called `arrow.type.traits.Time32Traits`.

**Example Usage**

```matlab
>> times = seconds([100 120 NaN 200])

times = 

  1×4 duration array

   100 sec   120 sec   NaN sec   200 sec

>> time32Array = arrow.array.Time32Array.fromMATLAB(times)

time32Array = 

[
  00:01:40,
  00:02:00,
  null,
  00:03:20
]

>> roundtrip = toMATLAB(time32Array)

roundtrip = 

  4×1 duration array

   100 sec
   120 sec
   NaN sec
   200 sec

```

You can also specify the `TimeUnit` to use via a name-value pair. `TimeUnit` can either be `"Second"`  (default) or `"Milisecond"`.

```matlab
>> times = seconds([100 120 NaN 200]);
>> time32Array = arrow.array.Time32Array.fromMATLAB(times, TimeUnit="Millisecond")

time32Array = 

[
  00:01:40.000,
  00:02:00.000,
  null,
  00:03:20.000
]
```

### Are these changes tested?

Yes. Added two new test classes: `tTime32Array.m` and `tTime32Traits.m`.

### Are there any user-facing changes?

Yes, users can now create `arrow.array.Time32Array`s from MATLAB `duration`s via the static `fromMATLAB` method on `arrow.array.Time32Array`.

### Future Directions

1. Add `arrow.array.Time64Array`
2. Add `arrow.type.Date32Type` and `arrow.array.Date32Array`
4. Add `arrow.type.Date64Type` and `arrow.array.Date64Array`

* Closes: #37290

Authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
@kevingurney @sgilmore10 @loicalleyne
apacheGH-37231: [MATLAB] Add arrow.type.Time32Type class and `arrow…
1044ca3 
….time32` construction function (apache#37250)

### Rationale for this change

To support the addition of `arrow.array.Time32Array`, this pull request adds a new `arrow.type.Time32Type` class and associated `arrow.time32` construction function to the MATLAB interface.

### What changes are included in this PR?

1. New `arrow.type.Time32Type` class.
2. New `arrow.time32` construction function that returns an `arrow.type.Time32Type` instance.

**Example**

```matlab
>> type = arrow.time32(TimeUnit="Millisecond")

type = 

  Time32Type with properties:

          ID: Time32
    TimeUnit: Millisecond

>> class(type)

ans =

    'arrow.type.Time32Type'
```

### Are these changes tested?

Yes.

1. Added new tests for `Time32` type ID enumeration to `tID`.
2. Added a test class `tTimeUnit` for the new validation function `arrow.internal.validate.temporal.timeUnit`.
4. Added a new test class `tTime32Type`.

### Are there any user-facing changes?

Yes.

There are two new user-facing APIs:

1. `arrow.time32` construction function
2. `arrow.type.Time32Type` class

### Future Directions:

1. apache#37232
2. apache#37229
3.  apache#37230
4. apache#37251

### Notes

1. Thank you @ sgilmore10 for your help with this pull request!
* Closes: apache#37231

Lead-authored-by: Kevin Gurney <kgurney@mathworks.com>
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
@kevingurney @loicalleyne
apacheGH-37253: [MATLAB] Add test cases which verify that the `NumFie…
1c11664 
…lds`, `BitWidth`, and `ID` properties can not be modified to `hFixedWidth` test class (apache#37316)

### Rationale for this change

As @ sgilmore10 pointed out in apache#37250 (comment), it makes sense to move the tests which verify that the `NumFields`, `BitWidth`, and `ID` properties cannot be set into the `hFixedWidthType` superclass, rather than having these tests implemented in `tTime32Type` and `tTime64Type`, since they are common to all fixed width types.

### What changes are included in this PR?

1. Moved tests which verify that the `BitWidth`, `NumFields`, and `ID` properties cannot be set out of the `tTime32Type` and `tTime64Type` classes and into the superclass `hFixedWidthType`.
2. Fixed typo in `tTime32Type` and `tTime64Type`. Changed variable name `schema` to `type`.

### Are these changes tested?

Yes.

1. Moved tests which verify that the `BitWidth`, `NumFields`, and `ID` properties cannot be set out of the `tTime32Type` and `tTime64Type` classes and into the superclass `hFixedWidthType`.

### Are there any user-facing changes?

No.

This pull request only modifies tests.
* Closes: apache#37253

Authored-by: Kevin Gurney <kgurney@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
@sgilmore10 @loicalleyne
apacheGH-37290: [MATLAB] Add arrow.array.Time32Array class (apache#…
c1c049d 
…37315)

### Rationale for this change

Now that the `arrow.type.Time32Type` class has been added to the MATLAB Interface (apache#37250), we can add the `arrow.array.Time32Array` class. 

### What changes are included in this PR?

1. Added a new class `arrow.array.Time32Array`. It has the following read-only properties: `Type` and `Length`. It has the following methods: `fromMATLAB()`, `toMATLAB()`, and `duration()`. For reference, `duration` arrays in MATLAB represent lengths of time in fixed-length units. Here's a [link](https://www.mathworks.com/help/matlab/ref/duration.html) to the documentation. 
2. Added a new class called `arrow.type.traits.Time32Traits`.

**Example Usage**

```matlab
>> times = seconds([100 120 NaN 200])

times = 

  1×4 duration array

   100 sec   120 sec   NaN sec   200 sec

>> time32Array = arrow.array.Time32Array.fromMATLAB(times)

time32Array = 

[
  00:01:40,
  00:02:00,
  null,
  00:03:20
]

>> roundtrip = toMATLAB(time32Array)

roundtrip = 

  4×1 duration array

   100 sec
   120 sec
   NaN sec
   200 sec

```

You can also specify the `TimeUnit` to use via a name-value pair. `TimeUnit` can either be `"Second"`  (default) or `"Milisecond"`.

```matlab
>> times = seconds([100 120 NaN 200]);
>> time32Array = arrow.array.Time32Array.fromMATLAB(times, TimeUnit="Millisecond")

time32Array = 

[
  00:01:40.000,
  00:02:00.000,
  null,
  00:03:20.000
]
```

### Are these changes tested?

Yes. Added two new test classes: `tTime32Array.m` and `tTime32Traits.m`.

### Are there any user-facing changes?

Yes, users can now create `arrow.array.Time32Array`s from MATLAB `duration`s via the static `fromMATLAB` method on `arrow.array.Time32Array`.

### Future Directions

1. Add `arrow.array.Time64Array`
2. Add `arrow.type.Date32Type` and `arrow.array.Date32Array`
4. Add `arrow.type.Date64Type` and `arrow.array.Date64Array`

* Closes: apache#37290

Authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sgilmore10 sgilmore10 sgilmore10 approved these changes

@kou kou Awaiting requested review from kou kou is a code owner

Assignees
No one assigned
Labels
Component: MATLAB
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[MATLAB] Add arrow.type.Time32Type class and arrow.time32 construction function
2 participants
@kevingurney @sgilmore10