Merge pull request #11 from arbCoding/devel

Custom exceptions and greater type safety.

Author: arbCoding

docs/index.html

@@ -43,7 +43,7 @@ with binary [[https://ds.iris.edu/files/sac-manual/manual/file_format.html][SAC]
 and easy to read programming-style while providing the high performance brought
 by C++.
 
-sac-format's actively developed on [[https://github.com/arbCoding/sac-format][GitHub]]!
+sac-format's developed on [[https://github.com/arbCoding/sac-format][GitHub]]!
 
 [[https://arbcoding.github.io/sac-format/sac-format_manual.pdf][Download]] an offline version of the documentation (PDF).
 
@@ -56,17 +56,22 @@ working on Windows, macOS, and Linux systems.
 
 *** Safe
 
-sac-format is *safe*---testing is an important part of software development. The
-sac-format library is extensively tested using the [[https://github.com/catchorg/Catch2][Catch2]] testing framework.
-Everything from low-level binary conversions to high-level =Trace= reading/writing
-are tested and confirmed working. Check and run the tests yourself. See the
-[[Testing][Testing]] section for more information.
+sac-format is *safe*---it conforms to a strict set of C++ programming guidelines,
+chosen to ensure safe code-execution. The guideline conformance list is in
+[[https://github.com/arbCoding/sac-format/blob/main/.github/workflows/cpp-linter.yml][=cpp-linter.yml=]] and can be cross-referenced against this [[https://clang.llvm.org/extra/clang-tidy/checks/list.html][master list]]. Results
+of conformance checking is [[https://github.com/arbCoding/sac-format/actions/workflows/cpp-linter.yml][here]].
+
+Testing is an important part of software development; the sac-format library is
+extensively tested using the [[https://github.com/catchorg/Catch2][Catch2]] testing framework. Everything from low-level
+binary conversions to high-level =Trace= reading/writing are tested and confirmed
+working. Check and run the tests yourself. See the [[Testing][Testing]] section for more
+information.
 
 *** Fast
 
-sac-format is *fast*---it's written in C++ and extensively benchmarked. You can
-run the benchmarks yourself to find out how sac-format performs on your system.
-See the [[Benchmarking][Benchmarking]] section for more information.
+sac-format is *fast*---it's written in C++, carefully optimized, and extensively
+benchmarked. You can run the benchmarks yourself to find out how sac-format
+performs on your system. See the [[Benchmarking][Benchmarking]] section for more information.
 
 *** Easy
 
@@ -78,7 +83,7 @@ running.
 *** Small
 
 sac-format is *small*---in total (header + implementation--excluding comments)
-it's fewer than 2000 lines of code. Small size opens the door to using on any
+it's fewer than 2500 lines of code. Small size opens the door to using on any
 sort of hardware (old or new) and makes it easy to expand upon.
 
 *** Documented
@@ -118,7 +123,7 @@ build tool, and then building.
 
 **** GCC
 
-#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize
+#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, bgcolor=LightGray
 #+begin_src bash :returns code :eval no
 git clone https://github.com/arbCoding/sac-format.git
 cmake --preset gcc-release
@@ -127,7 +132,7 @@ cmake --build ./build/release/gcc
 
 **** Clang
 
-#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize
+#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, bgcolor=LightGray
 #+begin_src bash :returns code :eval no
 git clone https://github.com/arbCoding/sac-format.git
 cmake --preset clang-release
@@ -152,7 +157,7 @@ well as the true size of the [[=data1=][=data1=]] and [[=data2=][=data2=]] vecto
 To integrate sac-format into your CMake project, add it to your =CMakeLists.txt=.
 
 #+latex: \begin{center}\begin{minipage}[t]{0.75\textwidth}
-#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos
+#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos, bgcolor=LightGray
 #+begin_src cmake :eval no
 include(FetchContent)
 set(FETCHCONTENT_UPDATES_DISCONNECTED TRUE)
@@ -180,7 +185,7 @@ target_link_libraries_library(your_executable
 
 #+latex: \begin{center}\begin{minipage}[t]{0.75\textwidth}
 #+name: empty_trace_example
-#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos
+#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos, bgcolor=LightGray
 #+begin_src cpp :cache yes :returns code :results verbatim :flags -std=c++20 -L../../bin/libsac-format.a -I../ :eval no
 #include <filesystem>
 #include <iostream>
@@ -215,11 +220,13 @@ The =Trace= class provides easy access to SAC-files in C++. Each SAC-file is a
 
 *** Reading SAC
 
-SAC-files can be read in by using the parameterized constructor with a [[https://en.cppreference.com/w/cpp/filesystem/path][=std::filesystem::path=]] ([[https://en.cppreference.com/w/cpp/header/filesystem][=<filesystem>=]]) or a [[https://en.cppreference.com/w/cpp/string/basic_string][=std::string=]] ([[https://en.cppreference.com/w/cpp/header/string][=<string>=]]) variable that corresponds to the location of the SAC-file.
+SAC-files can be read in by using the parameterized constructor with a
+[[https://en.cppreference.com/w/cpp/filesystem/path][=std::filesystem::path=]] ([[https://en.cppreference.com/w/cpp/header/filesystem][=<filesystem>=]]) or a [[https://en.cppreference.com/w/cpp/string/basic_string][=std::string=]] ([[https://en.cppreference.com/w/cpp/header/string][=<string>=]])
+variable that corresponds to the location of the SAC-file.
 
 For example:
 #+latex: \begin{center}\begin{minipage}[t]{0.75\textwidth}
-#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos
+#+attr_latex: :options frame=lines, framesep=2mm, baselinestretch=1.2, fontsize=\footnotesize, linenos, bgcolor=LightGray
 #+begin_src C++ :eval no
 #include <filesystem>
 #include <sac_foramt.hpp>
@@ -287,8 +294,8 @@ a [[Lookup Table][lookup table]]. The internal components are below:
 
 *** Exceptions
 
-sac-format throws exceptions of type =std::domain_exception= in the event of a
-failure to read/write a SAC-file.
+sac-format throws exceptions of type =sacfmt::io_error= in the event of a failure
+to read/write a SAC-file.
 
 ** Low-Level I/O
 
@@ -363,7 +370,7 @@ length.
 ***** =equal_within_tolerance=
 
 Floating-point/double-precision equality within a provided tolerance (default is
-=f_eps=, defined in [[=sac_format.hpp=]]).
+=f_eps=, defined in =sac_format.hpp=).
 
 ** Testing
 
@@ -417,7 +424,7 @@ Implementation---function details.
 
 **** =util.hpp=
 
-Utility functions and constants exclusive to testing and benchmarking. Is not
+Utility functions and constants exclusive to testing and benchmarking. Not
 split into interface/implementation.
 
 **** =utests.cpp=

docs/sac-format_manual.pdf

@@ -16,6 +16,7 @@
 #+latex_header: \usepackage{minted}
 #+latex_header: \setminted{breaklines}
 #+latex_header: \usepackage{xcolor}
+#+latex_header: \definecolor{LightGray}{gray}{0.975}
 #+latex_header: \usemintedstyle{emacs}
 #+latex_header: \usepackage{mathtools}
 #+latex_header: \usepackage[twoside, letterpaper, lmargin=1.0in, rmargin=0.75in, bmargin=0.75in, tmargin=1.0in]{geometry}