@@ -1014,7 +1014,9 @@ class ARROW_EXPORT DecimalType : public FixedSizeBinaryType {
1014
1014
static Result<std::shared_ptr<DataType>> Make (Type::type type_id, int32_t precision,
1015
1015
int32_t scale);
1016
1016
1017
+ // / \brief Returns the precision
1017
1018
int32_t precision () const { return precision_; }
1019
+ // / \brief Returns the scale
1018
1020
int32_t scale () const { return scale_; }
1019
1021
1020
1022
// / \brief Returns the number of bytes needed for precision.
@@ -1337,20 +1339,25 @@ class ARROW_EXPORT MapType : public ListType {
1337
1339
1338
1340
explicit MapType (std::shared_ptr<Field> value_field, bool keys_sorted = false );
1339
1341
1340
- // Validating constructor
1342
+ // / Validating constructor
1341
1343
static Result<std::shared_ptr<DataType>> Make (std::shared_ptr<Field> value_field,
1342
1344
bool keys_sorted = false );
1343
1345
1346
+ // / \brief Returns the key field
1344
1347
std::shared_ptr<Field> key_field () const { return value_type ()->field (0 ); }
1348
+ // / \brief Returns the key type
1345
1349
std::shared_ptr<DataType> key_type () const { return key_field ()->type (); }
1346
1350
1351
+ // / \brief Returns the item field
1347
1352
std::shared_ptr<Field> item_field () const { return value_type ()->field (1 ); }
1353
+ // / \brief Returns the item type
1348
1354
std::shared_ptr<DataType> item_type () const { return item_field ()->type (); }
1349
1355
1350
1356
std::string ToString (bool show_metadata = false ) const override ;
1351
1357
1352
1358
std::string name () const override { return " map" ; }
1353
1359
1360
+ // / \brief Returns the keys sorted
1354
1361
bool keys_sorted () const { return keys_sorted_; }
1355
1362
1356
1363
private:
@@ -1387,6 +1394,7 @@ class ARROW_EXPORT FixedSizeListType : public BaseListType {
1387
1394
1388
1395
std::string name () const override { return " fixed_size_list" ; }
1389
1396
1397
+ // / \brief Returns the list size
1390
1398
int32_t list_size () const { return list_size_; }
1391
1399
1392
1400
protected:
@@ -1471,8 +1479,10 @@ class ARROW_EXPORT UnionType : public NestedType {
1471
1479
// / An array mapping logical type ids to physical child ids.
1472
1480
const std::vector<int >& child_ids () const { return child_ids_; }
1473
1481
1482
+ // / \brief Returns the max type code
1474
1483
uint8_t max_type_code () const ;
1475
1484
1485
+ // / \brief Returns the mode
1476
1486
UnionMode::type mode () const ;
1477
1487
1478
1488
protected:
@@ -1508,7 +1518,7 @@ class ARROW_EXPORT SparseUnionType : public UnionType {
1508
1518
1509
1519
SparseUnionType (FieldVector fields, std::vector<int8_t > type_codes);
1510
1520
1511
- // A constructor variant that validates input parameters
1521
+ // / A constructor variant that validates input parameters
1512
1522
static Result<std::shared_ptr<DataType>> Make (FieldVector fields,
1513
1523
std::vector<int8_t > type_codes);
1514
1524
@@ -1537,7 +1547,7 @@ class ARROW_EXPORT DenseUnionType : public UnionType {
1537
1547
1538
1548
DenseUnionType (FieldVector fields, std::vector<int8_t > type_codes);
1539
1549
1540
- // A constructor variant that validates input parameters
1550
+ // / A constructor variant that validates input parameters
1541
1551
static Result<std::shared_ptr<DataType>> Make (FieldVector fields,
1542
1552
std::vector<int8_t > type_codes);
1543
1553
@@ -1560,13 +1570,16 @@ class ARROW_EXPORT RunEndEncodedType : public NestedType {
1560
1570
return DataTypeLayout ({DataTypeLayout::AlwaysNull ()});
1561
1571
}
1562
1572
1573
+ // / \brief Returns the run-end encoded type
1563
1574
const std::shared_ptr<DataType>& run_end_type () const { return fields ()[0 ]->type (); }
1575
+ // / \brief Returns the run-end encoded value type
1564
1576
const std::shared_ptr<DataType>& value_type () const { return fields ()[1 ]->type (); }
1565
1577
1566
1578
std::string ToString (bool show_metadata = false ) const override ;
1567
1579
1568
1580
std::string name () const override { return " run_end_encoded" ; }
1569
1581
1582
+ // / \brief Returns run-end encoded type is valid
1570
1583
static bool RunEndTypeValid (const DataType& run_end_type);
1571
1584
1572
1585
private:
@@ -1599,6 +1612,7 @@ class ARROW_EXPORT TemporalType : public FixedWidthType {
1599
1612
// / \brief Base type class for date data
1600
1613
class ARROW_EXPORT DateType : public TemporalType {
1601
1614
public:
1615
+ // / \brief Returns the unit
1602
1616
virtual DateUnit unit () const = 0;
1603
1617
1604
1618
protected:
@@ -1773,6 +1787,7 @@ class ARROW_EXPORT IntervalType : public TemporalType, public ParametricType {
1773
1787
public:
1774
1788
enum type { MONTHS, DAY_TIME, MONTH_DAY_NANO };
1775
1789
1790
+ // / \brief Returns the interval type
1776
1791
virtual type interval_type () const = 0;
1777
1792
1778
1793
protected:
@@ -1907,6 +1922,7 @@ class ARROW_EXPORT DurationType : public TemporalType, public ParametricType {
1907
1922
std::string ToString (bool show_metadata = false ) const override ;
1908
1923
std::string name () const override { return " duration" ; }
1909
1924
1925
+ // / \brief Returns the unit
1910
1926
TimeUnit::type unit () const { return unit_; }
1911
1927
1912
1928
protected:
@@ -1945,9 +1961,12 @@ class ARROW_EXPORT DictionaryType : public FixedWidthType {
1945
1961
1946
1962
DataTypeLayout layout () const override ;
1947
1963
1964
+ // / \brief Returns the index type
1948
1965
const std::shared_ptr<DataType>& index_type () const { return index_type_; }
1966
+ // / \brief Returns the value type
1949
1967
const std::shared_ptr<DataType>& value_type () const { return value_type_; }
1950
1968
1969
+ // / \brief Returns the ordered
1951
1970
bool ordered () const { return ordered_; }
1952
1971
1953
1972
protected:
@@ -2362,8 +2381,10 @@ class ARROW_EXPORT Schema : public detail::Fingerprintable,
2362
2381
// / Return the ith schema element. Does not boundscheck
2363
2382
const std::shared_ptr<Field>& field (int i) const ;
2364
2383
2384
+ // / \brief Returns fields
2365
2385
const FieldVector& fields () const ;
2366
2386
2387
+ // / \brief Returns field names
2367
2388
std::vector<std::string> field_names () const ;
2368
2389
2369
2390
// / Returns null if name not found
0 commit comments