]> git.proxmox.com Git - ceph.git/blame - ceph/src/arrow/go/arrow/doc.go
import quincy 17.2.0
[ceph.git] / ceph / src / arrow / go / arrow / doc.go
CommitLineData
1d09f67e
TL
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, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16
17/*
18Package arrow provides an implementation of Apache Arrow.
19
20Apache Arrow is a cross-language development platform for in-memory data. It specifies a standardized
21language-independent columnar memory format for flat and hierarchical data, organized for efficient analytic
22operations on modern hardware. It also provides computational libraries and zero-copy streaming
23messaging and inter-process communication.
24
25Basics
26
27The fundamental data structure in Arrow is an Array, which holds a sequence of values of the same type. An array
28consists of memory holding the data and an additional validity bitmap that indicates if the corresponding entry in the
29array is valid (not null). If the array has no null entries, it is possible to omit this bitmap.
30
31*/
32package arrow
33
34//go:generate go run _tools/tmpl/main.go -i -data=numeric.tmpldata type_traits_numeric.gen.go.tmpl type_traits_numeric.gen_test.go.tmpl array/numeric.gen.go.tmpl array/numericbuilder.gen.go.tmpl array/bufferbuilder_numeric.gen.go.tmpl
35//go:generate go run _tools/tmpl/main.go -i -data=datatype_numeric.gen.go.tmpldata datatype_numeric.gen.go.tmpl tensor/numeric.gen.go.tmpl tensor/numeric.gen_test.go.tmpl
36//go:generate go run _tools/tmpl/main.go -i -data=scalar/numeric.gen.go.tmpldata scalar/numeric.gen.go.tmpl scalar/numeric.gen_test.go.tmpl
37//go:generate go run ./gen-flatbuffers.go
38
39// stringer
40//go:generate stringer -type=Type