ceph/src/arrow/docs/source/cpp/api/compute.rst

   1 .. Licensed to the Apache Software Foundation (ASF) under one
   2 .. or more contributor license agreements.  See the NOTICE file
   3 .. distributed with this work for additional information
   4 .. regarding copyright ownership.  The ASF licenses this file
   5 .. to you under the Apache License, Version 2.0 (the
   6 .. "License"); you may not use this file except in compliance
   7 .. with the License.  You may obtain a copy of the License at
   8
   9 ..   http://www.apache.org/licenses/LICENSE-2.0
  10
  11 .. Unless required by applicable law or agreed to in writing,
  12 .. software distributed under the License is distributed on an
  13 .. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14 .. KIND, either express or implied.  See the License for the
  15 .. specific language governing permissions and limitations
  16 .. under the License.
  17
  18 Compute Functions
  19 =================
  20
  21 Datum class
  22 -----------
  23
  24 .. doxygenclass:: arrow::Datum
  25    :members:
  26
  27 Abstract Function classes
  28 -------------------------
  29
  30 .. doxygengroup:: compute-functions
  31    :content-only:
  32    :members:
  33
  34 Function registry
  35 -----------------
  36
  37 .. doxygenclass:: arrow::compute::FunctionRegistry
  38    :members:
  39
  40 .. doxygenfunction:: arrow::compute::GetFunctionRegistry
  41
  42 Convenience functions
  43 ---------------------
  44
  45 .. doxygengroup:: compute-call-function
  46    :content-only:
  47
  48 Concrete options classes
  49 ------------------------
  50
  51 .. doxygengroup:: compute-concrete-options
  52    :content-only:
  53    :members:
  54    :undoc-members:
  55
  56 .. TODO: List concrete function invocation shortcuts?