io.virtdata.libbasics.shared.from_long.to_int.HashAutoDocsInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation

With inspiration from other libraries

There is a newer version: 2.12.15

// This file is auto-generated.
package io.virtdata.libbasics.shared.from_long.to_int;

import io.virtdata.annotations.Category;
import io.virtdata.annotations.Service;
import io.virtdata.processors.DocCtorData;
import io.virtdata.processors.DocForFuncCtor;
import io.virtdata.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

@Service(DocFuncData.class)
public class HashAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "Hash";
  }

  public String getPackageName() {
    return "io.virtdata.libbasics.shared.from_long.to_int";
  }

  public String getClassJavadoc() {
    return "This uses the Murmur3F (64-bit optimized) version of Murmur3,\n"
            + "not as a checksum, but as a simple hash. It doesn't bother\n"
            + "pushing the high-64 bits of input, since it only uses the lower\n"
            + "64 bits of output. It does, however, return the absolute value.\n"
            + "This is to make it play nice with users and other libraries.\n";
  }

  public String getInType() {
    return "long";
  }

  public String getOutType() {
    return "int";
  }

  public Category[] getCategories() {
    return new Category[] {  };
  }

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Hash", "", 
            new LinkedHashMap() {{
            }},
            new ArrayList>() {{
            }}
          ));
        }};
  }
}