ARROW-17475: [Go] Function interface and Registry impl #13924
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,29 @@ | ||
| // 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. | ||
|
|
||
| // Package compute is a native-go implementation of an Acero-like | ||
| // arrow compute engine. | ||
| // | ||
| // While consumers of Arrow that are able to use CGO could utilize the | ||
| // C Data API (using the cdata package) and could link against the | ||
| // acero library directly, there are consumers who cannot use CGO. This | ||
| // is an attempt to provide for those users, and in general create a | ||
| // native-go arrow compute engine. | ||
| // | ||
| // Everything in this package should be considered Experimental for now. | ||
| package compute | ||
|
|
||
| //go:generate stringer -type=FuncKind -linecomment | ||
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,63 @@ | ||
| // 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. | ||
|
|
||
| package compute | ||
|
|
||
| import ( | ||
| "context" | ||
| ) | ||
|
|
||
| type Function interface { | ||
| Name() string | ||
| Kind() FuncKind | ||
| Arity() Arity | ||
| Doc() FunctionDoc | ||
| NumKernels() int | ||
|
There was a problem hiding this comment. Is it worth exposing this without also having a public concept of Kernels? There was a problem hiding this comment. I have a setup concept for Kernels, just haven't placed the interface in here yet (for the sake of keeping the size of this PR down) but they will almost certainly make into the 10.0.0 release so I'm okay with leaving this. |
||
| Execute(context.Context, FunctionOptions, ...Datum) (Datum, error) | ||
| DefaultOptions() FunctionOptions | ||
| Validate() error | ||
| } | ||
|
|
||
| type Arity struct { | ||
| NArgs int | ||
| IsVarArgs bool | ||
| } | ||
|
|
||
| func Nullary() Arity { return Arity{0, false} } | ||
| func Unary() Arity { return Arity{1, false} } | ||
| func Binary() Arity { return Arity{2, false} } | ||
| func Ternary() Arity { return Arity{3, false} } | ||
| func VarArgs(minArgs int) Arity { return Arity{minArgs, true} } | ||
|
|
||
| type FunctionDoc struct { | ||
| Summary string | ||
| Description string | ||
| ArgNames []string | ||
| OptionsClass string | ||
| OptionsRequired bool | ||
| } | ||
|
|
||
| var EmptyFuncDoc FunctionDoc | ||
|
|
||
| type FuncKind int8 | ||
|
|
||
| const ( | ||
| FuncScalar FuncKind = iota // Scalar | ||
| FuncVector // Vector | ||
| FuncScalarAgg // ScalarAggregate | ||
| FuncHashAgg // HashAggregate | ||
| FuncMeta // Meta | ||
| ) | ||
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. | ||
|
|
||
| package compute_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/apache/arrow/go/v10/arrow/compute" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestArityBasics(t *testing.T) { | ||
| nullary := compute.Nullary() | ||
| assert.Equal(t, 0, nullary.NArgs) | ||
| assert.False(t, nullary.IsVarArgs) | ||
|
|
||
| unary := compute.Unary() | ||
| assert.Equal(t, 1, unary.NArgs) | ||
| assert.False(t, unary.IsVarArgs) | ||
|
|
||
| binary := compute.Binary() | ||
| assert.Equal(t, 2, binary.NArgs) | ||
| assert.False(t, binary.IsVarArgs) | ||
|
|
||
| ternary := compute.Ternary() | ||
| assert.Equal(t, 3, ternary.NArgs) | ||
| assert.False(t, ternary.IsVarArgs) | ||
|
|
||
| varargs := compute.VarArgs(2) | ||
| assert.Equal(t, 2, varargs.NArgs) | ||
| assert.True(t, varargs.IsVarArgs) | ||
| } |
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
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.
Ah, so not just arrow::compute, but Acero itself is the goal.
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.
That's the goal yup. But it's a lofty goal. The first milestone is just simple scalar function execution...