125 lines
2.9 KiB
Groff
125 lines
2.9 KiB
Groff
.TH "include/utils.hpp" 3 "Mon Oct 2 2023" "Penning Trap Simulation" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
include/utils.hpp \- Function prototypes and macros that are useful\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <string>\fP
|
|
.br
|
|
\fC#include <vector>\fP
|
|
.br
|
|
\fC#include <iomanip>\fP
|
|
.br
|
|
\fC#include <sstream>\fP
|
|
.br
|
|
|
|
.SS "Macros"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "#define \fBDEBUG\fP(msg)"
|
|
.br
|
|
.RI "Writes a debug message\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::string \fBscientific_format\fP (double d, int width=20, int prec=10)"
|
|
.br
|
|
.RI "Turns a double into a string written in scientific format\&. "
|
|
.ti -1c
|
|
.RI "std::string \fBscientific_format\fP (const std::vector< double > &v, int width=20, int prec=10)"
|
|
.br
|
|
.RI "Turns a vector of doubles into a string written in scientific format\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Function prototypes and macros that are useful\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Cory Alexander Balaton (coryab)
|
|
.PP
|
|
Janita Ovidie Sandtrøen Willumsen (janitaws)
|
|
.RE
|
|
.PP
|
|
\fBVersion\fP
|
|
.RS 4
|
|
1\&.0
|
|
.RE
|
|
.PP
|
|
.PP
|
|
These utility function are mainly for convenience and aren't directly related to the project\&.
|
|
.PP
|
|
\fBBug\fP
|
|
.RS 4
|
|
No known bugs
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Definition in file \fButils\&.hpp\fP\&.
|
|
.SH "Macro Definition Documentation"
|
|
.PP
|
|
.SS "#define DEBUG(msg)"
|
|
|
|
.PP
|
|
Writes a debug message\&. This function writes a debug message that includes the filename, line number, and a custom message\&. The function is wrapped in an ifdef that checks if DBG is defined, so one can choose to display the debug messages by adding the -DDBG flag when compiling\&.
|
|
.PP
|
|
Definition at line \fB35\fP of file \fButils\&.hpp\fP\&.
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "std::string scientific_format (const std::vector< double > & v, int width = \fC20\fP, int prec = \fC10\fP)"
|
|
|
|
.PP
|
|
Turns a vector of doubles into a string written in scientific format\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIv\fP The vector to stringify
|
|
.br
|
|
\fIwidth\fP The reserved width of the string
|
|
.br
|
|
\fIprec\fP The precision of the stringified number
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
String
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Definition at line \fB21\fP of file \fButils\&.cpp\fP\&.
|
|
.SS "std::string scientific_format (double d, int width = \fC20\fP, int prec = \fC10\fP)"
|
|
|
|
.PP
|
|
Turns a double into a string written in scientific format\&. Code stolen from https://github.com/anderkve/FYS3150 Header: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/include/utils.hpp Source: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/src/utils.cpp
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fId\fP The number to stringify
|
|
.br
|
|
\fIwidth\fP The reserved width of the string
|
|
.br
|
|
\fIprec\fP The precision of the stringified number
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
String
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Definition at line \fB14\fP of file \fButils\&.cpp\fP\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.
|