negative.binomial Distribution Sampling

Draw samples from a negative binomial distribution.

hanaml.negative.binomial(
  connection.context,
  m = NULL,
  r = NULL,
  p = NULL,
  seed = NULL,
  thread.ratio = NULL
)

Arguments

connection.context

ConnectionContext
SAP HANA Database connection object.
m

integer, optional
Specifies the number of random data to be generated.
Defaults to 100.
r

numeric, optional
Number failures until success.
Defaults to 1.
p

numeric, optional
Successful fraction. The value range is from 0 to 1.
Defaults to 0.5.
seed

integer, optional
Indicates the seed used to initialize the random number generator:

  • 0: Uses the system time.

  • Not 0: Uses the specified seed.

Note that when multithreading is enabled, the random number sequences of different runs might be different even if the seed value remains the same.
Defaults to 0.
thread.ratio

double, optional
Controls the proportion of available threads that can be used by this function.
The value range is from 0 to 1, where 0 indicates a single thread, and 1 indicates all available threads.
Values between 0 and 1 will use up to that percentage of available threads.Values outside this range are ignored.
Defaults to 0.

Value

DataFrame containing the generated random samples, structured as follows:

  • ID: type INTEGER, ID column

  • GENERATED_NUMBER: type DOUBLE, sample values

Examples

Draw samples from a negative.binomial distribution:

> negative.binomial <- hanaml.negative.binomial(connection.context = conn,
                                                m = 20,
                                                r = 10,
                                                p = 0.6
                                                seed = 1,
                                                thread.ratio = 0)

Output:

 > negative.binomial$collect()
    ID  GENERATED_NUMBER
 1   0               0.0
 2   1               2.0
 3   2               3.0
 4   3               1.0
 5   4               1.0
 6   5               0.0
 7   6               2.0
 8   7               1.0
 9   8               2.0
 10  9               3.0