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

align master with 6.1.X Also #614

Merged
merged 2 commits into from
Dec 13, 2024
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ name: Serialization Compatibility Test

on:
push:
branches:
- master
branches: [ master, main ]
workflow_dispatch:

jobs:
Expand All @@ -19,7 +18,7 @@ jobs:
repository: apache/datasketches-cpp
path: cpp
- name: Setup Java
uses: actions/setup-java@v2
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
Expand Down
21 changes: 14 additions & 7 deletions .github/workflows/auto-jdk-matrix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: DataSketches-Java Auto JDK Matrix Test & Install
on:
pull_request:
push:
branches: [ master ]
branches: [ master, main ]
workflow_dispatch:

env:
Expand All @@ -13,43 +13,47 @@ jobs:
build:
name: Build, Test, Install
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
jdk: [ 8,11 ]

env:
JDK_VERSION: ${{ matrix.jdk }}

steps:
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Print Current workflow
run: >
cat .github/workflows/auto-jdk-matrix.yml

- name: Cache local Maven repository
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.m2/repository
key: build-${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: build-${{ runner.os }}-maven-

- name: Install Matrix JDK
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.jdk }}
distribution: 'temurin'
java-package: jdk
architecture: x64
# Architecture options: x86, x64, armv7, aarch64, ppc64le
# setup-java@v3 has a "with cache" option

- name: Echo Java Version
run: >
java -version

- name: Test
run: >
mvn clean test
mvn clean test -B
-Dmaven.javadoc.skip=true
-Dgpg.skip=true

Expand All @@ -59,7 +63,10 @@ jobs:
-DskipTests=true
-Dgpg.skip=true

# Architecture options: x86, x64, armv7, aarch64, ppc64le
# setup-java@v3 has a "with cache" option
# Lifecycle: validate, compile, test, package, verify, install, deploy
# -B batch mode
# -V show Version without stopping
# -X debug mode
# -q quiet, only show errors
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
name: DataSketches-Java Manual OS Matrix Test & Install
name: DataSketches-Java 8 Auto OS Matrix Test & Install

on:
pull_request:
push:
branches: [ master, main ]
workflow_dispatch:

env:
MAVEN_OPTS: -Xmx4g -Xms1g
MAVEN_OPTS: -Xmx1g -Xms1g

jobs:
build:
name: Build, Test, Install
runs-on: ${{matrix.os}}

strategy:
fail-fast: false

matrix:
jdk: [ 8, 11 ]
jdk: [ 8 ]
os: [ windows-latest, ubuntu-latest, macos-latest ]
include:
- os: windows-latest
Expand All @@ -26,31 +30,31 @@ jobs:
skip_javadoc: -Dmaven.javadoc.skip=true
skip_gpg: -Dgpg.skip=true

runs-on: ${{matrix.os}}

env:
JDK_VERSION: ${{ matrix.jdk }}

steps:
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Cache local Maven repository
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.m2/repository
key: build-${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: build-${{ runner.os }}-maven-

- name: Install Matrix JDK
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.jdk }}
distribution: 'temurin'
java-package: jdk
architecture: x64
# Architecture options: x86, x64, armv7, aarch64, ppc64le
# setup-java@v3 has a "with cache" option

- name: Echo Java Version
run: >
Expand All @@ -69,7 +73,9 @@ jobs:
-D skipTests=true
${{matrix.os.skip_gpg}}

# Architecture options: x86, x64, armv7, aarch64, ppc64le
# setup-java@v4 has a "with cache" option
# Lifecycle: validate, compile, test, package, verify, install, deploy
# -B batch mode
# -V show Version without stopping
# -q quiet, only show errors
# -q quiet, only show errors
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
name: "CodeQL"

on:
push:
branches: [ 'master' ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ 'master' ]
schedule:
- cron: '10 17 * * 4'
workflow_dispatch:

jobs:
Expand All @@ -28,11 +21,11 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
uses: github/codeql-action/init@v4
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
Expand Down
71 changes: 0 additions & 71 deletions .github/workflows/manual-coverage.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
name: JavaDoc

on:
push:
branches:
- master
workflow_dispatch:

jobs:
javadoc:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Generate JavaDoc
run: mvn javadoc:javadoc
- name: Deploy JavaDoc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
import org.apache.datasketches.memory.XxHash;

/**
* <p>A Bloom filter is a data structure that can be used for probabilistic
* set membership.</p>
* A Bloom filter is a data structure that can be used for probabilistic
* set membership.
*
* <p>When querying a Bloom filter, there are no false positives. Specifically:
* When querying an item that has already been inserted to the filter, the filter will
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
import org.apache.datasketches.memory.WritableMemory;

/**
* <p>This class provides methods to help estimate the correct parameters when
* creating a Bloom filter, and methods to create the filter using those values.</p>
* This class provides methods to help estimate the correct parameters when
* creating a Bloom filter, and methods to create the filter using those values.
*
* <p>The underlying math is described in the
* <a href='https://en.wikipedia.org/wiki/Bloom_filter#Optimal_number_of_hash_functions'>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@
import org.apache.datasketches.memory.WritableMemory;

/**
* <p>This sketch is useful for tracking approximate frequencies of items of type <i>&lt;T&gt;</i>
* This sketch is useful for tracking approximate frequencies of items of type <i>&lt;T&gt;</i>
* with optional associated counts (<i>&lt;T&gt;</i> item, <i>long</i> count) that are members of a
* multiset of such items. The true frequency of an item is defined to be the sum of associated
* counts.</p>
* counts.
*
* <p>This implementation provides the following capabilities:</p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@
import org.apache.datasketches.memory.WritableMemory;

/**
* <p>This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional
* This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional
* associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of
* such items. The true frequency of an item is defined to be the sum of associated counts.</p>
* such items. The true frequency of an item is defined to be the sum of associated counts.
*
* <p>This implementation provides the following capabilities:</p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@
/**
* This class defines the preamble data structure and provides basic utilities for some of the key
* fields.
* <p>
* The intent of the design of this class was to isolate the detailed knowledge of the bit and byte
*
* <p>The intent of the design of this class was to isolate the detailed knowledge of the bit and byte
* layout of the serialized form of the sketches derived from the Sketch class into one place. This
* allows the possibility of the introduction of different serialization schemes with minimal impact
* on the rest of the library.
* </p>
* on the rest of the library.</p>
*
* <p>
* MAP: Low significance bytes of this <i>long</i> data structure are on the right. However, the
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/org/apache/datasketches/hash/MurmurHash3.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@
import org.apache.datasketches.memory.Memory;

/**
* <p>
* The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has
* excellent avalanche and 2-way bit independence properties.
* </p>
*
* <p>
* Austin Appleby's C++
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/apache/datasketches/hash/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,11 @@
*/

/**
* <p>The hash package contains a high-performing and extended Java implementations
* The hash package contains a high-performing and extended Java implementations
* of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.
* This core MurmurHash3.java class is used throughout many of the sketch classes for consistency
* and as long as the user specifies the same seed will result in coordinated hash operations.
* This package also contains an adaptor class that extends the basic class with more functions
* commonly associated with hashing.
* </p>
*/
package org.apache.datasketches.hash;
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@ private static void randomlyHalveUpDoubles(final double[] buf, final int start,

/**
* Compression algorithm used to merge higher levels.
*
* <p>Here is what we do for each level:</p>
* <ul><li>If it does not need to be compacted, then simply copy it over.</li>
* <li>Otherwise, it does need to be compacted, so...
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ public final void merge(final KllSketch other) {

/**
* {@inheritDoc}
*
* <p>The parameter <i>k</i> will not change.</p>
*/
@Override
Expand Down
Loading
Loading