Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links #779

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ endif()
########################################################################
# Install our Cmake modules into $prefix/lib/cmake/volk
# See "Package Configuration Files" on page:
# http://www.cmake.org/Wiki/CMake/Tutorials/Packaging
# https://gitlab.kitware.com/cmake/community/-/wikis/doc/tutorials/Packaging
########################################################################

configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/VolkConfig.cmake.in
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# Welcome to VOLK!

VOLK is a sub-project of GNU Radio. Please see http://libvolk.org for bug
VOLK is a sub-project of GNU Radio. Please see https://www.libvolk.org/ for bug
tracking, documentation, source code, and contact information about VOLK.
See https://www.gnuradio.org/ for information about GNU Radio.

Expand All @@ -20,7 +20,7 @@ https://www.gnuradio.org/git/volk.git/.

## How to use VOLK:

For detailed instructions see http://libvolk.org/doxygen/using_volk.html
For detailed instructions see https://www.libvolk.org/doxygen/using_volk.html

See these steps for a quick build guide.

Expand Down
2 changes: 1 addition & 1 deletion cmake/Modules/VolkAddTest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ function(VOLK_ADD_TEST test_name executable_name)
file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR} srcdir)
list(APPEND environs "srcdir=\"${srcdir}\"")

#http://www.cmake.org/pipermail/cmake/2009-May/029464.html
#https://cmake.org/pipermail/cmake/2009-May/029464.html
#Replaced this add test + set environs code with the shell script generation.
#Its nicer to be able to manually run the shell script to diagnose problems.
if(UNIX)
Expand Down
2 changes: 1 addition & 1 deletion cmake/cmake_uninstall.cmake.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
#

# http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F
# https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake

if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
message(
Expand Down
2 changes: 1 addition & 1 deletion cmake/msvc/sys/time.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#define NOMINMAX
#endif

// http://social.msdn.microsoft.com/Forums/en/vcgeneral/thread/430449b3-f6dd-4e18-84de-eebd26a8d668
// https://learn.microsoft.com/en-us/archive/msdn-technet-forums/430449b3-f6dd-4e18-84de-eebd26a8d668
#include < time.h >
#include <windows.h> //I've omitted this line.
#if defined(_MSC_VER) || defined(_MSC_EXTENSIONS)
Expand Down
4 changes: 2 additions & 2 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Changelog
All notable changes to VOLK will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html), starting with version 2.0.0.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), starting with version 2.0.0.


## [2.0.0] - 2019-08-06
Expand Down
20 changes: 11 additions & 9 deletions docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,7 @@ VERBATIM_HEADERS = YES

# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see:
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
# https://clang.llvm.org/) for more accurate parsing at the cost of reduced
# performance. This can be particularly helpful with template rich C++ code for
# which doxygen's built-in parser lacks the necessary type information.
# Note: The availability of this option depends on whether or not doxygen was
Expand All @@ -1178,7 +1178,7 @@ CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the directory containing a file called compile_commands.json. This
# file is the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
# https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
# options used when the source files were built. This is equivalent to
# specifying the -p option to a clang tool, such as clang-check. These options
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
Expand Down Expand Up @@ -1659,7 +1659,7 @@ USE_MATHJAX = NO

# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
# https://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
Expand All @@ -1675,10 +1675,12 @@ MATHJAX_FORMAT = HTML-CSS
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from https://www.mathjax.org before deployment.
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
# The default value is:
# in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
# in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB: Functional change, potentially.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

USE_MATHJAX is currently set to NO, so I think we should be good.

Please also see below.
https://www.mathjax.org/cdn-shutting-down/
doxygen/doxygen@2c7bba0

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.mathjax.org/en/latest/web/start.html#using-mathjax-from-a-content-delivery-network-cdn
It looks like jsdelivr is the mathjax recommended way. However, I couldn't find any recommendation from Doxygen on which version to use. The latest version seems to be 3.2 which is a rewrite with updated everything.

Which MathJax version is required by Doxygen?

Assuming Ubuntu is the most legacy-ish distro and we would potentially start to use MathJax, would MathJax 3 work with the Ubuntu 22.04 doxygen default?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ubuntu 22.04 currently ships doxygen (1.9.1-2ubuntu2). The support for MathJax 3 was added in 1.9.4 in doxygen/doxygen#9218.

Looking at the changelogs https://changelogs.ubuntu.com/changelogs/pool/universe/d/doxygen/doxygen_1.9.1-2ubuntu2/changelog, the support was not backported.


# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
Expand All @@ -1690,7 +1692,7 @@ MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
# https://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.

Expand Down Expand Up @@ -2153,7 +2155,7 @@ DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------

# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
Expand Down Expand Up @@ -2357,7 +2359,7 @@ HIDE_UNDOC_RELATIONS = YES

# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: YES.
Expand Down Expand Up @@ -2534,7 +2536,7 @@ DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# https://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
Expand Down
6 changes: 3 additions & 3 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Semantic Versioning Specification (SemVer)

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).
interpreted as described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119).

1. Software using Semantic Versioning MUST declare a public API. This API
could be declared in the code itself or exist strictly in documentation.
Expand Down Expand Up @@ -265,7 +265,7 @@ About
-----

The Semantic Versioning specification is authored by [Tom
Preston-Werner](http://tom.preston-werner.com), inventor of Gravatars and
Preston-Werner](https://tom.preston-werner.com/), inventor of Gravatars and
cofounder of GitHub.

If you'd like to leave feedback, please [open an issue on
Expand All @@ -276,4 +276,4 @@ License
-------

Creative Commons - CC BY 3.0
http://creativecommons.org/licenses/by/3.0/
https://creativecommons.org/licenses/by/3.0/
2 changes: 1 addition & 1 deletion gen/volk_kernel_defs.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
########################################################################
# Strip comments from a c/cpp file.
# Input is code string, output is code string without comments.
# http://stackoverflow.com/questions/241327/python-snippet-to-remove-c-and-c-comments
# https://stackoverflow.com/questions/241327/remove-c-and-c-comments-using-python
########################################################################
def comment_remover(text):
def replacer(match):
Expand Down
8 changes: 4 additions & 4 deletions include/volk/volk_avx_intrinsics.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,10 @@ static inline __m256 _mm256_polar_sign_mask(__m128i fbits)
__m256 sign_mask =
_mm256_insertf128_ps(sign_mask_dummy, _mm_castsi128_ps(sign_bits0), 0x0);
return _mm256_insertf128_ps(sign_mask, _mm_castsi128_ps(sign_bits1), 0x1);
// // This is the desired function call. Though it seems to be missing in GCC.
// // Compare: https://software.intel.com/sites/landingpage/IntrinsicsGuide/#
// return _mm256_set_m128(_mm_castsi128_ps(sign_bits1),
// _mm_castsi128_ps(sign_bits0));
// This is the desired function call. Though it seems to be missing in GCC.
// Compare: https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html
// return _mm256_set_m128(_mm_castsi128_ps(sign_bits1),
// _mm_castsi128_ps(sign_bits0));
tinyboxvk marked this conversation as resolved.
Show resolved Hide resolved
}

static inline void
Expand Down
2 changes: 1 addition & 1 deletion include/volk/volk_common.h
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@

////////////////////////////////////////////////////////////////////////
// Define VOLK_API for library symbols
// http://gcc.gnu.org/wiki/Visibility
// https://gcc.gnu.org/wiki/Visibility
////////////////////////////////////////////////////////////////////////
#ifdef volk_EXPORTS
#define VOLK_API __VOLK_ATTR_EXPORT
Expand Down
2 changes: 1 addition & 1 deletion include/volk/volk_complex.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ typedef double complex lv_64fc_t;

// When GNUC is available, use the complex extensions.
// The extensions always return the correct value type.
// http://gcc.gnu.org/onlinedocs/gcc/Complex.html
// https://gcc.gnu.org/onlinedocs/gcc/Complex.html
#ifdef __GNUC__

#define lv_creal(x) (__real__(x))
Expand Down
4 changes: 2 additions & 2 deletions include/volk/volk_malloc.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ __VOLK_DECL_BEGIN
* see: https://linux.die.net/man/3/aligned_alloc
* For MSVC, we fall back to `_aligned_malloc`.
* see:
* https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-malloc?view=vs-2019
* https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-malloc?view=msvc-170
*
* Because of the ways in which volk_malloc may allocate memory, it is
* important to always free volk_malloc pointers using volk_free.
Expand All @@ -51,7 +51,7 @@ VOLK_API void* volk_malloc(size_t size, size_t alignment);
* see: https://en.cppreference.com/w/c/memory/free
* In case `_aligned_malloc` was used, we call `_aligned_free`.
* see:
* https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-free?view=vs-2019
* https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-free?view=msvc-170
*
* \param aptr The aligned pointer allocated by volk_malloc.
*/
Expand Down
2 changes: 1 addition & 1 deletion kernels/volk/volk_32f_log2_32f.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* +-Inf outputs are mapped to +-127.0f and +-NaN input values are not supported.
*
* This kernel was adapted from Jose Fonseca's Fast SSE2 log implementation
* http://jrfonseca.blogspot.in/2008/09/fast-sse2-pow-tables-or-polynomials.htm
* https://jrfonseca.blogspot.com/2008/09/fast-sse2-pow-tables-or-polynomials.html
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
Expand Down
4 changes: 2 additions & 2 deletions kernels/volk/volk_32fc_x2_divide_32fc.h
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ static inline void volk_32fc_x2_divide_32fc_u_avx(lv_32fc_t* cVector,
sq, sq); // obtain the actual squared magnitude, although out of order
mag_sq = _mm256_permute_ps(mag_sq_un, 0xd8); // I order them
// best guide I found on using these functions:
// https://software.intel.com/sites/landingpage/IntrinsicsGuide/#expand=2738,2059,2738,2738,3875,3874,3875,2738,3870
// https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#ig_expand=2738,2059,2738,2738,3875,3874,3875,2738,3870
div = _mm256_div_ps(mul_conj, mag_sq);

_mm256_storeu_ps((float*)c, div); // Store the results back into the C container
Expand Down Expand Up @@ -313,7 +313,7 @@ static inline void volk_32fc_x2_divide_32fc_a_avx(lv_32fc_t* cVector,
{
/*
* Guide to AVX intrisics:
* https://software.intel.com/sites/landingpage/IntrinsicsGuide/#
* https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html
*
* we'll do the "classical"
* a a b*
Expand Down
6 changes: 3 additions & 3 deletions kernels/volk/volk_32u_reverse_32u.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#ifndef INCLUDED_VOLK_32u_REVERSE_32u_U_H

// Idea from "Bit Twiddling Hacks", which dedicates this method to public domain
// http://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
// https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
static const unsigned char BitReverseTable256[] = {
0x00, 0x80, 0x40, 0xC0, 0x20, 0xA0, 0x60, 0xE0, 0x10, 0x90, 0x50, 0xD0, 0x30, 0xB0,
0x70, 0xF0, 0x08, 0x88, 0x48, 0xC8, 0x28, 0xA8, 0x68, 0xE8, 0x18, 0x98, 0x58, 0xD8,
Expand Down Expand Up @@ -120,7 +120,7 @@ static inline void volk_32u_reverse_32u_byte_shuffle(uint32_t* out,
#endif /* LV_HAVE_GENERIC */

// Idea from "Bit Twiddling Hacks", which dedicates this method to public domain
// http://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
// https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
#ifdef LV_HAVE_GENERIC
static inline void
volk_32u_reverse_32u_lut(uint32_t* out, const uint32_t* in, unsigned int num_points)
Expand All @@ -140,7 +140,7 @@ volk_32u_reverse_32u_lut(uint32_t* out, const uint32_t* in, unsigned int num_poi
#endif /* LV_HAVE_GENERIC */

// Single-Byte code from "Bit Twiddling Hacks", which dedicates this method to public
// domain http://graphics.stanford.edu/~seander/bithacks.html#ReverseByteWith64Bits
// domain https://graphics.stanford.edu/~seander/bithacks.html#ReverseByteWith64Bits
#ifdef LV_HAVE_GENERIC
static inline void
volk_32u_reverse_32u_2001magic(uint32_t* out, const uint32_t* in, unsigned int num_points)
Expand Down
2 changes: 1 addition & 1 deletion kernels/volk/volk_8u_x2_encodeframepolar_8u.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

static inline unsigned int log2_of_power_of_2(unsigned int val)
{
// algorithm from: http://graphics.stanford.edu/~seander/bithacks.html#IntegerLog
// algorithm from: https://graphics.stanford.edu/~seander/bithacks.html#IntegerLog
static const unsigned int b[] = {
0xAAAAAAAA, 0xCCCCCCCC, 0xF0F0F0F0, 0xFF00FF00, 0xFFFF0000
};
Expand Down
2 changes: 1 addition & 1 deletion kernels/volk/volk_8u_x3_encodepolarpuppet_8u.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
static inline unsigned int next_lower_power_of_two(const unsigned int val)
{
// algorithm found and adopted from:
// http://acius2.blogspot.de/2007/11/calculating-next-power-of-2.html
// https://acius2.blogspot.com/2007/11/calculating-next-power-of-2.html
unsigned int res = val;
res = (res >> 1) | res;
res = (res >> 2) | res;
Expand Down
2 changes: 1 addition & 1 deletion lib/testqa.cc
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ int main(int argc, char* argv[])

/*
* This function prints qa results as XML output similar to output
* from Junit. For reference output see http://llg.cubic.org/docs/junit/
* from Junit. For reference output see https://llg.cubic.org/docs/junit/
*/
void print_qa_xml(std::vector<volk_test_results_t> results, unsigned int nfails)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/volk_malloc.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*
* MSVC is broken
* see:
* https://docs.microsoft.com/en-us/cpp/overview/visual-cpp-language-conformance?view=vs-2019
* https://learn.microsoft.com/en-us/cpp/overview/visual-cpp-language-conformance?view=msvc-170
* This section:
* C11 The Universal CRT implemented the parts of the
* C11 Standard Library that are required by C++17,
Expand Down