Hide docs for protocols and associated extensions in vector module

Author: wigging

Sources/VectorModule/Algebra.swift

@@ -4,6 +4,7 @@ Linear algebra protocol and extensions for the Vector struct.
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Algebra {
     static func dot(_ a: Vector<Self>, _ b: Vector<Self>) -> Self
     static func norm(_ a: Vector<Self>) -> Self
@@ -14,6 +15,7 @@ public protocol Algebra {
     static func swapValues(a: inout Vector<Self>, b: inout Vector<Self>)
 }
 
+@_documentation(visibility: private)
 extension Int: Algebra {
 
     public static func swapValues(a: inout Vector<Int>, b: inout Vector<Int>) {
@@ -71,6 +73,7 @@ extension Int: Algebra {
     }
 }
 
+@_documentation(visibility: private)
 extension Float: Algebra {
 
     public static func swapValues(a: inout Vector<Float>, b: inout Vector<Float>) {
@@ -110,6 +113,7 @@ extension Float: Algebra {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Algebra {
 
     public static func swapValues(a: inout Vector<Double>, b: inout Vector<Double>) {

Sources/VectorModule/Arithmetic.swift

@@ -4,6 +4,7 @@ Arithmetic protocol and extensions for the Vector struct.
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Arithmetic {
     static func add(_ a: Vector<Self>, _ k: Self) -> Vector<Self>
     static func add(_ a: Vector<Self>, _ b: Vector<Self>) -> Vector<Self>
@@ -17,6 +18,7 @@ public protocol Arithmetic {
     static func divide(_ a: Vector<Self>, _ b: Vector<Self>) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Int: Arithmetic {
 
     public static func add(_ a: Vector<Int>, _ k: Int) -> Vector<Int> {
@@ -100,6 +102,7 @@ extension Int: Arithmetic {
     }
 }
 
+@_documentation(visibility: private)
 extension Float: Arithmetic {
 
     public static func add(_ a: Vector<Float>, _ k: Float) -> Vector<Float> {
@@ -171,6 +174,7 @@ extension Float: Arithmetic {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Arithmetic {
 
     public static func add(_ a: Vector<Double>, _ k: Double) -> Vector<Double> {

Sources/VectorModule/Documentation.docc/LinearAlgebra.md

@@ -0,0 +1,16 @@
+# Linear Algebra
+
+Linear algebra vector operations.
+
+## Overview
+
+Numerix implements linear algebra operations using the Accelerate framework and BLAS routines. See the home page of the documentation for more information about the supported BLAS routines.
+
+## Topics
+
+- ``Vector/dot(_:)``
+- ``Vector/norm()``
+- ``Vector/scale(by:)``
+- ``Vector/sum()``
+- ``Vector/absoluteSum()``
+- ``Vector/cumulativeSum()``

Sources/VectorModule/Documentation.docc/Trigonometry.md

@@ -0,0 +1,13 @@
+# Trigonometry
+
+Trigonometic vector operations.
+
+## Overview
+
+Numerix provides several element-wise trigometric functions for vectors. The Accelerate framework is utilized for efficient element-by-element vector operations. 
+
+## Topics
+
+- ``sin(_:)``
+- ``cos(_:)``
+- ``tan(_:)``

Sources/VectorModule/Documentation.docc/VectorModule.md

@@ -7,3 +7,6 @@ One-dimensional vector operations.
 This module provides the ``Vector`` structure for working with one-dimensional numerical data. Arithmetic and several linear algebra operations are supported. See the topics below for more details. Scalar values can be Float or Double and limited support is provided for Int values.
 
 ## Topics
+
+- <doc:LinearAlgebra>
+- <doc:Trigonometry>

Sources/VectorModule/Exponential.swift

@@ -4,12 +4,14 @@ Vector extension for exponential functions.
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Exponential {
     static func exp(a: Vector<Self>) -> Vector<Self>
     static func exp2(a: Vector<Self>) -> Vector<Self>
     static func expm1(a: Vector<Self>) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Float: Exponential {
     public static func exp(a: Vector<Float>) -> Vector<Float> {
         var mat = Vector(like: a)
@@ -30,6 +32,7 @@ extension Float: Exponential {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Exponential {
     public static func exp(a: Vector<Double>) -> Vector<Double> {
         var mat = Vector(like: a)

Sources/VectorModule/Logarithm.swift

@@ -4,6 +4,7 @@ Vector extension for logarithm functions.
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Logarithm {
     static func log(a: Vector<Self>) -> Vector<Self>
     static func log1p(a: Vector<Self>) -> Vector<Self>
@@ -12,6 +13,7 @@ public protocol Logarithm {
     static func logb(a: Vector<Self>) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Float: Logarithm {
     public static func log(a: Vector<Float>) -> Vector<Float> {
         var result = Vector(like: a)
@@ -44,6 +46,7 @@ extension Float: Logarithm {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Logarithm {
     public static func log(a: Vector<Double>) -> Vector<Double> {
         var result = Vector(like: a)

Sources/VectorModule/Power.swift

@@ -4,11 +4,13 @@ Vector extension for power functions.
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Power {
     static func power(a: Vector<Self>, exp: Self) -> Vector<Self>
     static func power(a: Vector<Self>, exp: [Self]) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Float: Power {
     public static func power(a: Vector<Float>, exp: Float) -> Vector<Float> {
         let output = Vector(like: a)
@@ -28,6 +30,7 @@ extension Float: Power {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Power {
     public static func power(a: Vector<Double>, exp: Double) -> Vector<Double> {
         let output = Vector(like: a)

Sources/VectorModule/RandomDistribution.swift

@@ -4,10 +4,12 @@
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol RandomDistribution {
     static func randomDist(size: Int, dist: Int) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Float: RandomDistribution {
 
     public static func randomDist(size: Int, dist: Int) -> Vector<Float> {
@@ -25,6 +27,7 @@ extension Float: RandomDistribution {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: RandomDistribution {
 
     public static func randomDist(size: Int, dist: Int) -> Vector<Double> {

Sources/VectorModule/Trigonometry.swift

@@ -4,12 +4,14 @@
 
 import Accelerate
 
+@_documentation(visibility: private)
 public protocol Trigonometry {
     static func sin(_ a: Vector<Self>) -> Vector<Self>
     static func cos(_ a: Vector<Self>) -> Vector<Self>
     static func tan(_ a: Vector<Self>) -> Vector<Self>
 }
 
+@_documentation(visibility: private)
 extension Float: Trigonometry {
 
     public static func sin(_ a: Vector<Float>) -> Vector<Float> {
@@ -31,6 +33,7 @@ extension Float: Trigonometry {
     }
 }
 
+@_documentation(visibility: private)
 extension Double: Trigonometry {
 
     public static func sin(_ a: Vector<Double>) -> Vector<Double> {