← Back to branch summary

~ubuntu-branches/ubuntu/saucy/openturns/saucy

« back to all changes in this revision

Viewing changes to debian/rotRPackage/man/predictValuesLm.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Christophe Prud'homme
  • Date: 2008-10-03 10:55:20 UTC
  • Revision ID: james.westby@ubuntu.com-20081003105520-i4sqk110f19vp7hd
Tags: 0.12.1-6
* debian/rules: Fix FTBS on hppa, sparc, arm, and armel because of
  __sync_fetch_and_add_4 not being available, the remedy is to use
  -DBOOST_SP_USE_PTHREADS
* debian/rules: add --disable-debug option to configure and set the
  compiler flags to -g -O2 (no -Wall)

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/rotRPackage/man/predictValuesLm.Rd
 
1
\name{predictValuesLm}
 
2
\alias{predictValuesLm}
 
3
\title{Predicts values through a linear model}
 
4
\description{
 
5
This ROT function, called from a LinearModel C++ object, and given a       
 
6
sample, is used to predict the corresponding values through the linear     
 
7
model. It returns the predicted sample.                                    
 
8
}
 
9
\usage{
 
10
predictValuesLm(x, beta)
 
11
}
 
12
\arguments{
 
13
  \item{x}{A m-by-n matrix containing the explanatory variables.}
 
14
  \item{beta}{A n-by-1 vector containng the linear model parameters.}
 
15
}
 
16
\value{
 
17
A m-by-1 vector is returned, containing the predicted values.}
 
18
\details{
 
19
As it is not asked in LinearModel.getPredict(), no prediction interval 
 
20
is returned; it is up to the user to be careful about that. It is also to  
 
21
noted that the sample is not assumed to contain the '1's corresponding to  
 
22
the intercept parameter.
 
23
}
 
24
\author{Pierre-Matthieu Pair, Softia for EDF.}
 
25
\examples{
 
26
set.seed(1)
 
27
x <- matrix(runif(40), 10, 4)
 
28
r <- matrix(c(1,2,3,4), 4, 1)
 
29
y <- x \%*\% r + matrix(rnorm(10, 0, 0.05), 10, 1)
 
30
LM <- computeLinearModel(x, y)
 
31
predictValuesLm(x, LM$parameterEstimate) 
 
32
}
 
33
\keyword{multivariate}