io.objectbox.model.HnswFlags Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectbox-java Show documentation

ObjectBox is a fast NoSQL database for Objects

The newest version!

/*
 * Copyright 2024 ObjectBox Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// automatically generated by the FlatBuffers compiler, do not modify

package io.objectbox.model;

/**
 * Flags as a part of the HNSW configuration.
 */
@SuppressWarnings("unused")
public final class HnswFlags {
  private HnswFlags() { }
  /**
   * Enables debug logs.
   */
  public static final int DebugLogs = 1;
  /**
   * Enables "high volume" debug logs, e.g. individual gets/puts.
   */
  public static final int DebugLogsDetailed = 2;
  /**
   * Padding for SIMD is enabled by default, which uses more memory but may be faster. This flag turns it off.
   */
  public static final int VectorCacheSimdPaddingOff = 4;
  /**
   * If the speed of removing nodes becomes a concern in your use case, you can speed it up by setting this flag.
   * By default, repairing the graph after node removals creates more connections to improve the graph's quality.
   * The extra costs for this are relatively low (e.g. vs. regular indexing), and thus the default is recommended.
   */
  public static final int ReparationLimitCandidates = 8;
}