This file is indexed.

/usr/share/doc/libdds-dev/readme.txt is in libdds-dev 2.5.2+ddd105-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
DDS 2.4,  Bo Haglund 2014-03-01

For Win32, DDS compiles with Visual C++ 2010 and 2012 Express editions 
and the TDM-GCC/Mingw port of gcc.

When using Visual C++, the statement
#include "stdafx.h" at the beginning of dds.cpp must be uncommented.
   

Linking with an application using DDS
-------------------------------------
The InitStart() function of DDS should be called from inside the
application. Then SolveBoard in DDS can be called multiple times
without the overhead of InitStart() at each call.
For this purpose, the application code must have an include
statement for the dll.h file in DDS.


Maximum number of threads
------------------------- 
The maximum number of simultaneous threads depends on the PC physical memory size:
1 GB or less, max 2 threads.
2 GB, max 4 threads.
3 or 4 GB, max 16 threads.
 
For e.g. Windows, allocating memory for the maximum number of simultaneous threads can 
be done by reading out the physical memory size from Windows. This is done in the DDS.DLL.
Another alternative is to provide the physical memory size as a parameter (gb_ram) in the
InitStart call. This alternative needs to be used when the operating system does not support
memory autoconfiguration.


Setting the number of simultaneous threads when calling CalcDDtable.
--------------------------------------------------------------------
For Windows, this can be done either by reading out the number of processor cores 
and using this for setting the number of threads, or by supplying the number of
threads (ncores) in InitStart. This latter alternative needs to be used when the operating 
system does not support reading out of the number of processors. 
 

Options at DDS compilation
--------------------------
Compiling options:

The SolveBoard and CalcDDtable are included in all DDS compilation options.
The "PBN" and the "PBN_PLUS" definitions are included in the header fill dll.h.
Defining "PBN" means that the functions SolveBoardPBN and CalcDDtablePBN are supported.
Defining "PBN_PLUS" as well means that also the functions SolveAllBoards,
SolveAllChunks, ParCalc and ParCalcPBN are supported.

The possible configurations thus are:

1)   None of the definitions "PBN" and "PBN_plus": 
     only the basic functions SolveBoard and CalcDDtable are supported.
2)  "PBN":  Also support for SolveBoardPBN and CalcDDtablePBN.
3)  "PBN" and "PBN_PLUS":  As for "PBN" and also supporting SolveAllBoards,
     SolveAllChunks, SolveAllTables, SolveAllTablesPBN, ParCalc and ParCalcPBN.

Staying with the previous configuration might be needed when 2.5.1 is to replace an 
older 2.x.y version, and the application using DDS cannot handle a changed interface.