io.virtdata.libbasics.shared.from_long.to_long.ShuffleAutoDocsInfo 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_long;

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 ShuffleAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "Shuffle";
  }

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

  public String getClassJavadoc() {
    return "This function provides a low-overhead shuffling effect without loading\n"
            + "elements into memory. It uses a bundled dataset of pre-computed\n"
            + "Galois LFSR shift register configurations, along with a down-sampling\n"
            + "method to provide amortized virtual shuffling with minimal memory usage.\n"
            + "\n"
            + "Essentially, this guarantees that every value in the specified range will\n"
            + "be seen at least once before the cycle repeats. However, since the order\n"
            + "of traversal of these values is dependent on the LFSR configuration, some\n"
            + "orders will appear much more random than others depending on where you\n"
            + "are in the traversal cycle.\n"
            + "\n"
            + "This function *does* yield values that are deterministic.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Shuffle", "", 
            new LinkedHashMap() {{
              put("min","long");
              put("maxPlusOne","long");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Shuffle(11,99)");
                add("Provide all values between 11 and 98 inclusive, in some order, then repeat");
              }});
            }}
          ));
          add(new DocForFuncCtor("Shuffle", "", 
            new LinkedHashMap() {{
              put("min","long");
              put("maxPlusOne","long");
              put("bankSelector","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Shuffle(11,99,3)");
                add("Provide all values between 11 and 98 inclusive, in some different (and repeatable) order, then repeat");
              }});
            }}
          ));
        }};
  }
}